From 28a831898975d05a95fef17bf9398111ffe537e6 Mon Sep 17 00:00:00 2001 From: Sai Cheemalapati Date: Tue, 24 Jan 2017 23:37:13 -0800 Subject: [PATCH] Regen APIs and add dfareporting:v2.7 (#524) Also bump version. --- Gemfile | 2 +- api_names.yaml | 2556 ++++ api_names_out.yaml | 2556 ++++ .../google/apis/adexchangebuyer2_v2beta1.rb | 2 +- generated/google/apis/adsense_v1_4.rb | 2 +- generated/google/apis/adsensehost_v4_1.rb | 2 +- generated/google/apis/androidenterprise_v1.rb | 2 +- .../apis/androidenterprise_v1/service.rb | 46 - generated/google/apis/appstate_v1.rb | 2 +- generated/google/apis/cloudbuild_v1.rb | 2 +- .../google/apis/cloudbuild_v1/classes.rb | 1256 +- .../apis/cloudbuild_v1/representations.rb | 330 +- .../google/apis/cloudbuild_v1/service.rb | 588 +- .../google/apis/cloudresourcemanager_v1.rb | 2 +- .../apis/cloudresourcemanager_v1beta1.rb | 2 +- generated/google/apis/dfareporting_v2_7.rb | 40 + .../google/apis/dfareporting_v2_7/classes.rb | 11876 ++++++++++++++++ .../apis/dfareporting_v2_7/representations.rb | 4243 ++++++ .../google/apis/dfareporting_v2_7/service.rb | 9095 ++++++++++++ generated/google/apis/dns_v1.rb | 2 +- generated/google/apis/dns_v2beta1.rb | 2 +- .../games_configuration_v1configuration.rb | 2 +- .../apis/games_management_v1management.rb | 2 +- generated/google/apis/games_v1.rb | 2 +- .../google/apis/logging_v2beta1/classes.rb | 1442 +- .../apis/logging_v2beta1/representations.rb | 330 +- .../google/apis/logging_v2beta1/service.rb | 432 +- generated/google/apis/monitoring_v3.rb | 2 +- generated/google/apis/plus_domains_v1.rb | 2 +- generated/google/apis/plus_v1.rb | 2 +- generated/google/apis/sheets_v4.rb | 6 +- generated/google/apis/sheets_v4/classes.rb | 10600 +++++++------- .../google/apis/sheets_v4/representations.rb | 3546 ++--- generated/google/apis/sheets_v4/service.rb | 444 +- generated/google/apis/slides_v1.rb | 2 +- generated/google/apis/webmasters_v3.rb | 2 +- generated/google/apis/youtube_analytics_v1.rb | 2 +- generated/google/apis/youtubereporting_v1.rb | 2 +- lib/google/apis/version.rb | 2 +- script/generate | 1 + 40 files changed, 39876 insertions(+), 9555 deletions(-) create mode 100644 generated/google/apis/dfareporting_v2_7.rb create mode 100644 generated/google/apis/dfareporting_v2_7/classes.rb create mode 100644 generated/google/apis/dfareporting_v2_7/representations.rb create mode 100644 generated/google/apis/dfareporting_v2_7/service.rb diff --git a/Gemfile b/Gemfile index 9c1d9e077..1fc7ee735 100644 --- a/Gemfile +++ b/Gemfile @@ -26,7 +26,7 @@ end platforms :jruby do group :development do - gem 'jruby-openssl' + gem 'jruby-openssl' end end diff --git a/api_names.yaml b/api_names.yaml index b0270dc1c..d4dc3cda1 100644 --- a/api_names.yaml +++ b/api_names.yaml @@ -33378,3 +33378,2559 @@ /dns:v2beta1/ResourceRecordSetsListResponse/rrsets/rrset: rrset /dns:v2beta1/ResponseHeader: response_header /dns:v2beta1/ResponseHeader/operationId: operation_id +/dfareporting:v2.7/fields: fields +/dfareporting:v2.7/key: key +/dfareporting:v2.7/quotaUser: quota_user +/dfareporting:v2.7/userIp: user_ip +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get: get_account_active_ad_summary +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get/summaryAccountId: summary_account_id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get: get_account_permission_group +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get/id: id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.list: list_account_permission_groups +/dfareporting:v2.7/dfareporting.accountPermissionGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissions.get: get_account_permission +/dfareporting:v2.7/dfareporting.accountPermissions.get/id: id +/dfareporting:v2.7/dfareporting.accountPermissions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissions.list: list_account_permissions +/dfareporting:v2.7/dfareporting.accountPermissions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.get: get_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.get/id: id +/dfareporting:v2.7/dfareporting.accountUserProfiles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.insert: insert_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list: list_account_user_profiles +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/active: active +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/ids: ids +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/searchString: search_string +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/userRoleId: user_role_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch: patch_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch/id: id +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.update: update_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.get: get_account +/dfareporting:v2.7/dfareporting.accounts.get/id: id +/dfareporting:v2.7/dfareporting.accounts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.list: list_accounts +/dfareporting:v2.7/dfareporting.accounts.list/active: active +/dfareporting:v2.7/dfareporting.accounts.list/ids: ids +/dfareporting:v2.7/dfareporting.accounts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.accounts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.accounts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.accounts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.accounts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.accounts.patch: patch_account +/dfareporting:v2.7/dfareporting.accounts.patch/id: id +/dfareporting:v2.7/dfareporting.accounts.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.update: update_account +/dfareporting:v2.7/dfareporting.accounts.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.get: get_ad +/dfareporting:v2.7/dfareporting.ads.get/id: id +/dfareporting:v2.7/dfareporting.ads.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.insert: insert_ad +/dfareporting:v2.7/dfareporting.ads.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.list: list_ads +/dfareporting:v2.7/dfareporting.ads.list/active: active +/dfareporting:v2.7/dfareporting.ads.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.ads.list/archived: archived +/dfareporting:v2.7/dfareporting.ads.list/audienceSegmentIds: audience_segment_ids +/dfareporting:v2.7/dfareporting.ads.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.ads.list/compatibility: compatibility +/dfareporting:v2.7/dfareporting.ads.list/creativeIds: creative_ids +/dfareporting:v2.7/dfareporting.ads.list/creativeOptimizationConfigurationIds: creative_optimization_configuration_ids +/dfareporting:v2.7/dfareporting.ads.list/dynamicClickTracker: dynamic_click_tracker +/dfareporting:v2.7/dfareporting.ads.list/ids: ids +/dfareporting:v2.7/dfareporting.ads.list/landingPageIds: landing_page_ids +/dfareporting:v2.7/dfareporting.ads.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.ads.list/overriddenEventTagId: overridden_event_tag_id +/dfareporting:v2.7/dfareporting.ads.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.ads.list/placementIds: placement_ids +/dfareporting:v2.7/dfareporting.ads.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.list/remarketingListIds: remarketing_list_ids +/dfareporting:v2.7/dfareporting.ads.list/searchString: search_string +/dfareporting:v2.7/dfareporting.ads.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.ads.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.ads.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.ads.list/sslCompliant: ssl_compliant +/dfareporting:v2.7/dfareporting.ads.list/sslRequired: ssl_required +/dfareporting:v2.7/dfareporting.ads.list/type: type +/dfareporting:v2.7/dfareporting.ads.patch: patch_ad +/dfareporting:v2.7/dfareporting.ads.patch/id: id +/dfareporting:v2.7/dfareporting.ads.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.update: update_ad +/dfareporting:v2.7/dfareporting.ads.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.delete: delete_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.delete/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.get: get_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.get/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.insert: insert_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.list: list_advertiser_groups +/dfareporting:v2.7/dfareporting.advertiserGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.advertiserGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.advertiserGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.advertiserGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.advertiserGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.advertiserGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.advertiserGroups.patch: patch_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.patch/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.update: update_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.get: get_advertiser +/dfareporting:v2.7/dfareporting.advertisers.get/id: id +/dfareporting:v2.7/dfareporting.advertisers.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.insert: insert_advertiser +/dfareporting:v2.7/dfareporting.advertisers.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.list: list_advertisers +/dfareporting:v2.7/dfareporting.advertisers.list/advertiserGroupIds: advertiser_group_ids +/dfareporting:v2.7/dfareporting.advertisers.list/floodlightConfigurationIds: floodlight_configuration_ids +/dfareporting:v2.7/dfareporting.advertisers.list/ids: ids +/dfareporting:v2.7/dfareporting.advertisers.list/includeAdvertisersWithoutGroupsOnly: include_advertisers_without_groups_only +/dfareporting:v2.7/dfareporting.advertisers.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.advertisers.list/onlyParent: only_parent +/dfareporting:v2.7/dfareporting.advertisers.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.advertisers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.list/searchString: search_string +/dfareporting:v2.7/dfareporting.advertisers.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.advertisers.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.advertisers.list/status: status +/dfareporting:v2.7/dfareporting.advertisers.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.advertisers.patch: patch_advertiser +/dfareporting:v2.7/dfareporting.advertisers.patch/id: id +/dfareporting:v2.7/dfareporting.advertisers.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.update: update_advertiser +/dfareporting:v2.7/dfareporting.advertisers.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.browsers.list: list_browsers +/dfareporting:v2.7/dfareporting.browsers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert: insert_campaign_creative_association +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list: list_campaign_creative_associations +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.campaigns.get: get_campaign +/dfareporting:v2.7/dfareporting.campaigns.get/id: id +/dfareporting:v2.7/dfareporting.campaigns.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.insert: insert_campaign +/dfareporting:v2.7/dfareporting.campaigns.insert/defaultLandingPageName: default_landing_page_name +/dfareporting:v2.7/dfareporting.campaigns.insert/defaultLandingPageUrl: default_landing_page_url +/dfareporting:v2.7/dfareporting.campaigns.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.list: list_campaigns +/dfareporting:v2.7/dfareporting.campaigns.list/advertiserGroupIds: advertiser_group_ids +/dfareporting:v2.7/dfareporting.campaigns.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.campaigns.list/archived: archived +/dfareporting:v2.7/dfareporting.campaigns.list/atLeastOneOptimizationActivity: at_least_one_optimization_activity +/dfareporting:v2.7/dfareporting.campaigns.list/excludedIds: excluded_ids +/dfareporting:v2.7/dfareporting.campaigns.list/ids: ids +/dfareporting:v2.7/dfareporting.campaigns.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.campaigns.list/overriddenEventTagId: overridden_event_tag_id +/dfareporting:v2.7/dfareporting.campaigns.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.campaigns.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.list/searchString: search_string +/dfareporting:v2.7/dfareporting.campaigns.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.campaigns.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.campaigns.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.campaigns.patch: patch_campaign +/dfareporting:v2.7/dfareporting.campaigns.patch/id: id +/dfareporting:v2.7/dfareporting.campaigns.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.update: update_campaign +/dfareporting:v2.7/dfareporting.campaigns.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.get: get_change_log +/dfareporting:v2.7/dfareporting.changeLogs.get/id: id +/dfareporting:v2.7/dfareporting.changeLogs.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.list: list_change_logs +/dfareporting:v2.7/dfareporting.changeLogs.list/action: action +/dfareporting:v2.7/dfareporting.changeLogs.list/ids: ids +/dfareporting:v2.7/dfareporting.changeLogs.list/maxChangeTime: max_change_time +/dfareporting:v2.7/dfareporting.changeLogs.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.changeLogs.list/minChangeTime: min_change_time +/dfareporting:v2.7/dfareporting.changeLogs.list/objectIds: object_ids +/dfareporting:v2.7/dfareporting.changeLogs.list/objectType: object_type +/dfareporting:v2.7/dfareporting.changeLogs.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.changeLogs.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.list/searchString: search_string +/dfareporting:v2.7/dfareporting.changeLogs.list/userProfileIds: user_profile_ids +/dfareporting:v2.7/dfareporting.cities.list: list_cities +/dfareporting:v2.7/dfareporting.cities.list/countryDartIds: country_dart_ids +/dfareporting:v2.7/dfareporting.cities.list/dartIds: dart_ids +/dfareporting:v2.7/dfareporting.cities.list/namePrefix: name_prefix +/dfareporting:v2.7/dfareporting.cities.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.cities.list/regionDartIds: region_dart_ids +/dfareporting:v2.7/dfareporting.connectionTypes.get: get_connection_type +/dfareporting:v2.7/dfareporting.connectionTypes.get/id: id +/dfareporting:v2.7/dfareporting.connectionTypes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.connectionTypes.list: list_connection_types +/dfareporting:v2.7/dfareporting.connectionTypes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.delete: delete_content_category +/dfareporting:v2.7/dfareporting.contentCategories.delete/id: id +/dfareporting:v2.7/dfareporting.contentCategories.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.get: get_content_category +/dfareporting:v2.7/dfareporting.contentCategories.get/id: id +/dfareporting:v2.7/dfareporting.contentCategories.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.insert: insert_content_category +/dfareporting:v2.7/dfareporting.contentCategories.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.list: list_content_categories +/dfareporting:v2.7/dfareporting.contentCategories.list/ids: ids +/dfareporting:v2.7/dfareporting.contentCategories.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.contentCategories.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.contentCategories.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.list/searchString: search_string +/dfareporting:v2.7/dfareporting.contentCategories.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.contentCategories.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.contentCategories.patch: patch_content_category +/dfareporting:v2.7/dfareporting.contentCategories.patch/id: id +/dfareporting:v2.7/dfareporting.contentCategories.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.update: update_content_category +/dfareporting:v2.7/dfareporting.contentCategories.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.conversions.batchinsert: batchinsert_conversion +/dfareporting:v2.7/dfareporting.conversions.batchinsert/profileId: profile_id +/dfareporting:v2.7/dfareporting.countries.get: get_country +/dfareporting:v2.7/dfareporting.countries.get/dartId: dart_id +/dfareporting:v2.7/dfareporting.countries.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.countries.list: list_countries +/dfareporting:v2.7/dfareporting.countries.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeAssets.insert: insert_creative_asset +/dfareporting:v2.7/dfareporting.creativeAssets.insert/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.creativeAssets.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete: delete_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get: get_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert: insert_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list: list_creative_field_values +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch: patch_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.update: update_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.update/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.delete: delete_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.delete/id: id +/dfareporting:v2.7/dfareporting.creativeFields.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.get: get_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.get/id: id +/dfareporting:v2.7/dfareporting.creativeFields.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.insert: insert_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.list: list_creative_fields +/dfareporting:v2.7/dfareporting.creativeFields.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.creativeFields.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeFields.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeFields.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeFields.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeFields.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeFields.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeFields.patch: patch_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.patch/id: id +/dfareporting:v2.7/dfareporting.creativeFields.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.update: update_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.get: get_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.get/id: id +/dfareporting:v2.7/dfareporting.creativeGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.insert: insert_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.list: list_creative_groups +/dfareporting:v2.7/dfareporting.creativeGroups.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.creativeGroups.list/groupNumber: group_number +/dfareporting:v2.7/dfareporting.creativeGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeGroups.patch: patch_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.patch/id: id +/dfareporting:v2.7/dfareporting.creativeGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.update: update_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.get: get_creative +/dfareporting:v2.7/dfareporting.creatives.get/id: id +/dfareporting:v2.7/dfareporting.creatives.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.insert: insert_creative +/dfareporting:v2.7/dfareporting.creatives.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.list: list_creatives +/dfareporting:v2.7/dfareporting.creatives.list/active: active +/dfareporting:v2.7/dfareporting.creatives.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.creatives.list/archived: archived +/dfareporting:v2.7/dfareporting.creatives.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.creatives.list/companionCreativeIds: companion_creative_ids +/dfareporting:v2.7/dfareporting.creatives.list/creativeFieldIds: creative_field_ids +/dfareporting:v2.7/dfareporting.creatives.list/ids: ids +/dfareporting:v2.7/dfareporting.creatives.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creatives.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creatives.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.list/renderingIds: rendering_ids +/dfareporting:v2.7/dfareporting.creatives.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creatives.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.creatives.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creatives.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creatives.list/studioCreativeId: studio_creative_id +/dfareporting:v2.7/dfareporting.creatives.list/types: types +/dfareporting:v2.7/dfareporting.creatives.patch: patch_creative +/dfareporting:v2.7/dfareporting.creatives.patch/id: id +/dfareporting:v2.7/dfareporting.creatives.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.update: update_creative +/dfareporting:v2.7/dfareporting.creatives.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.dimensionValues.query: query_dimension_value +/dfareporting:v2.7/dfareporting.dimensionValues.query/maxResults: max_results +/dfareporting:v2.7/dfareporting.dimensionValues.query/pageToken: page_token +/dfareporting:v2.7/dfareporting.dimensionValues.query/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.get: get_directory_site_contact +/dfareporting:v2.7/dfareporting.directorySiteContacts.get/id: id +/dfareporting:v2.7/dfareporting.directorySiteContacts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.list: list_directory_site_contacts +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/ids: ids +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.directorySites.get: get_directory_site +/dfareporting:v2.7/dfareporting.directorySites.get/id: id +/dfareporting:v2.7/dfareporting.directorySites.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.insert: insert_directory_site +/dfareporting:v2.7/dfareporting.directorySites.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.list: list_directory_sites +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsInStreamVideoPlacements: accepts_in_stream_video_placements +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsInterstitialPlacements: accepts_interstitial_placements +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsPublisherPaidPlacements: accepts_publisher_paid_placements +/dfareporting:v2.7/dfareporting.directorySites.list/active: active +/dfareporting:v2.7/dfareporting.directorySites.list/countryId: country_id +/dfareporting:v2.7/dfareporting.directorySites.list/dfp_network_code: dfp_network_code +/dfareporting:v2.7/dfareporting.directorySites.list/ids: ids +/dfareporting:v2.7/dfareporting.directorySites.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.directorySites.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.directorySites.list/parentId: parent_id +/dfareporting:v2.7/dfareporting.directorySites.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.list/searchString: search_string +/dfareporting:v2.7/dfareporting.directorySites.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.directorySites.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete: delete_dynamic_targeting_key +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/name: name +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/objectId: object_id_ +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/objectType: object_type +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.insert: insert_dynamic_targeting_key +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list: list_dynamic_targeting_keys +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/names: names +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/objectId: object_id_ +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/objectType: object_type +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.delete: delete_event_tag +/dfareporting:v2.7/dfareporting.eventTags.delete/id: id +/dfareporting:v2.7/dfareporting.eventTags.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.get: get_event_tag +/dfareporting:v2.7/dfareporting.eventTags.get/id: id +/dfareporting:v2.7/dfareporting.eventTags.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.insert: insert_event_tag +/dfareporting:v2.7/dfareporting.eventTags.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.list: list_event_tags +/dfareporting:v2.7/dfareporting.eventTags.list/adId: ad_id +/dfareporting:v2.7/dfareporting.eventTags.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.eventTags.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.eventTags.list/definitionsOnly: definitions_only +/dfareporting:v2.7/dfareporting.eventTags.list/enabled: enabled +/dfareporting:v2.7/dfareporting.eventTags.list/eventTagTypes: event_tag_types +/dfareporting:v2.7/dfareporting.eventTags.list/ids: ids +/dfareporting:v2.7/dfareporting.eventTags.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.list/searchString: search_string +/dfareporting:v2.7/dfareporting.eventTags.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.eventTags.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.eventTags.patch: patch_event_tag +/dfareporting:v2.7/dfareporting.eventTags.patch/id: id +/dfareporting:v2.7/dfareporting.eventTags.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.update: update_event_tag +/dfareporting:v2.7/dfareporting.eventTags.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.files.get: get_file +/dfareporting:v2.7/dfareporting.files.get/fileId: file_id +/dfareporting:v2.7/dfareporting.files.get/reportId: report_id +/dfareporting:v2.7/dfareporting.files.list: list_files +/dfareporting:v2.7/dfareporting.files.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.files.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.files.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.files.list/scope: scope +/dfareporting:v2.7/dfareporting.files.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.files.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivities.delete: delete_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.delete/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag: generatetag_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.get: get_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.get/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.insert: insert_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list: list_floodlight_activities +/dfareporting:v2.7/dfareporting.floodlightActivities.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupIds: floodlight_activity_group_ids +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupName: floodlight_activity_group_name +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupTagString: floodlight_activity_group_tag_string +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupType: floodlight_activity_group_type +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightActivities.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.floodlightActivities.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.floodlightActivities.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/searchString: search_string +/dfareporting:v2.7/dfareporting.floodlightActivities.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.floodlightActivities.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivities.list/tagString: tag_string +/dfareporting:v2.7/dfareporting.floodlightActivities.patch: patch_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.update: update_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get: get_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get/id: id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.insert: insert_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list: list_floodlight_activity_groups +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/type: type +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch: patch_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.update: update_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get: get_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get/id: id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list: list_floodlight_configurations +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch: patch_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.update: update_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.get: get_inventory_item +/dfareporting:v2.7/dfareporting.inventoryItems.get/id: id +/dfareporting:v2.7/dfareporting.inventoryItems.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.get/projectId: project_id +/dfareporting:v2.7/dfareporting.inventoryItems.list: list_inventory_items +/dfareporting:v2.7/dfareporting.inventoryItems.list/ids: ids +/dfareporting:v2.7/dfareporting.inventoryItems.list/inPlan: in_plan +/dfareporting:v2.7/dfareporting.inventoryItems.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.inventoryItems.list/orderId: order_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.inventoryItems.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/projectId: project_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/siteId: site_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.inventoryItems.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.inventoryItems.list/type: type +/dfareporting:v2.7/dfareporting.landingPages.delete: delete_landing_page +/dfareporting:v2.7/dfareporting.landingPages.delete/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.delete/id: id +/dfareporting:v2.7/dfareporting.landingPages.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.get: get_landing_page +/dfareporting:v2.7/dfareporting.landingPages.get/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.get/id: id +/dfareporting:v2.7/dfareporting.landingPages.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.insert: insert_landing_page +/dfareporting:v2.7/dfareporting.landingPages.insert/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.list: list_landing_pages +/dfareporting:v2.7/dfareporting.landingPages.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.patch: patch_landing_page +/dfareporting:v2.7/dfareporting.landingPages.patch/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.patch/id: id +/dfareporting:v2.7/dfareporting.landingPages.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.update: update_landing_page +/dfareporting:v2.7/dfareporting.landingPages.update/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.languages.list: list_languages +/dfareporting:v2.7/dfareporting.languages.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.metros.list: list_metros +/dfareporting:v2.7/dfareporting.metros.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.mobileCarriers.get: get_mobile_carrier +/dfareporting:v2.7/dfareporting.mobileCarriers.get/id: id +/dfareporting:v2.7/dfareporting.mobileCarriers.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.mobileCarriers.list: list_mobile_carriers +/dfareporting:v2.7/dfareporting.mobileCarriers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get: get_operating_system_version +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get/id: id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.list: list_operating_system_versions +/dfareporting:v2.7/dfareporting.operatingSystemVersions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystems.get: get_operating_system +/dfareporting:v2.7/dfareporting.operatingSystems.get/dartId: dart_id +/dfareporting:v2.7/dfareporting.operatingSystems.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystems.list: list_operating_systems +/dfareporting:v2.7/dfareporting.operatingSystems.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.get: get_order_document +/dfareporting:v2.7/dfareporting.orderDocuments.get/id: id +/dfareporting:v2.7/dfareporting.orderDocuments.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.get/projectId: project_id +/dfareporting:v2.7/dfareporting.orderDocuments.list: list_order_documents +/dfareporting:v2.7/dfareporting.orderDocuments.list/approved: approved +/dfareporting:v2.7/dfareporting.orderDocuments.list/ids: ids +/dfareporting:v2.7/dfareporting.orderDocuments.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.orderDocuments.list/orderId: order_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.orderDocuments.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/projectId: project_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/searchString: search_string +/dfareporting:v2.7/dfareporting.orderDocuments.list/siteId: site_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.orderDocuments.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.orders.get: get_order +/dfareporting:v2.7/dfareporting.orders.get/id: id +/dfareporting:v2.7/dfareporting.orders.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.orders.get/projectId: project_id +/dfareporting:v2.7/dfareporting.orders.list: list_orders +/dfareporting:v2.7/dfareporting.orders.list/ids: ids +/dfareporting:v2.7/dfareporting.orders.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.orders.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.orders.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orders.list/projectId: project_id +/dfareporting:v2.7/dfareporting.orders.list/searchString: search_string +/dfareporting:v2.7/dfareporting.orders.list/siteId: site_id +/dfareporting:v2.7/dfareporting.orders.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.orders.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementGroups.get: get_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.get/id: id +/dfareporting:v2.7/dfareporting.placementGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.insert: insert_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.list: list_placement_groups +/dfareporting:v2.7/dfareporting.placementGroups.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/archived: archived +/dfareporting:v2.7/dfareporting.placementGroups.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/contentCategoryIds: content_category_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.placementGroups.list/maxEndDate: max_end_date +/dfareporting:v2.7/dfareporting.placementGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placementGroups.list/maxStartDate: max_start_date +/dfareporting:v2.7/dfareporting.placementGroups.list/minEndDate: min_end_date +/dfareporting:v2.7/dfareporting.placementGroups.list/minStartDate: min_start_date +/dfareporting:v2.7/dfareporting.placementGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placementGroups.list/placementGroupType: placement_group_type +/dfareporting:v2.7/dfareporting.placementGroups.list/placementStrategyIds: placement_strategy_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/pricingTypes: pricing_types +/dfareporting:v2.7/dfareporting.placementGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placementGroups.list/siteIds: site_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placementGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementGroups.patch: patch_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.patch/id: id +/dfareporting:v2.7/dfareporting.placementGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.update: update_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.delete: delete_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.delete/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.get: get_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.get/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.insert: insert_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.list: list_placement_strategies +/dfareporting:v2.7/dfareporting.placementStrategies.list/ids: ids +/dfareporting:v2.7/dfareporting.placementStrategies.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placementStrategies.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placementStrategies.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placementStrategies.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placementStrategies.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementStrategies.patch: patch_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.patch/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.update: update_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.generatetags: generatetags_placement +/dfareporting:v2.7/dfareporting.placements.generatetags/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.placements.generatetags/placementIds: placement_ids +/dfareporting:v2.7/dfareporting.placements.generatetags/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.generatetags/tagFormats: tag_formats +/dfareporting:v2.7/dfareporting.placements.get: get_placement +/dfareporting:v2.7/dfareporting.placements.get/id: id +/dfareporting:v2.7/dfareporting.placements.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.insert: insert_placement +/dfareporting:v2.7/dfareporting.placements.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.list: list_placements +/dfareporting:v2.7/dfareporting.placements.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.placements.list/archived: archived +/dfareporting:v2.7/dfareporting.placements.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.placements.list/compatibilities: compatibilities +/dfareporting:v2.7/dfareporting.placements.list/contentCategoryIds: content_category_ids +/dfareporting:v2.7/dfareporting.placements.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.placements.list/groupIds: group_ids +/dfareporting:v2.7/dfareporting.placements.list/ids: ids +/dfareporting:v2.7/dfareporting.placements.list/maxEndDate: max_end_date +/dfareporting:v2.7/dfareporting.placements.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placements.list/maxStartDate: max_start_date +/dfareporting:v2.7/dfareporting.placements.list/minEndDate: min_end_date +/dfareporting:v2.7/dfareporting.placements.list/minStartDate: min_start_date +/dfareporting:v2.7/dfareporting.placements.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placements.list/paymentSource: payment_source +/dfareporting:v2.7/dfareporting.placements.list/placementStrategyIds: placement_strategy_ids +/dfareporting:v2.7/dfareporting.placements.list/pricingTypes: pricing_types +/dfareporting:v2.7/dfareporting.placements.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placements.list/siteIds: site_ids +/dfareporting:v2.7/dfareporting.placements.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.placements.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placements.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placements.patch: patch_placement +/dfareporting:v2.7/dfareporting.placements.patch/id: id +/dfareporting:v2.7/dfareporting.placements.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.update: update_placement +/dfareporting:v2.7/dfareporting.placements.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.platformTypes.get: get_platform_type +/dfareporting:v2.7/dfareporting.platformTypes.get/id: id +/dfareporting:v2.7/dfareporting.platformTypes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.platformTypes.list: list_platform_types +/dfareporting:v2.7/dfareporting.platformTypes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.postalCodes.get: get_postal_code +/dfareporting:v2.7/dfareporting.postalCodes.get/code: code +/dfareporting:v2.7/dfareporting.postalCodes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.postalCodes.list: list_postal_codes +/dfareporting:v2.7/dfareporting.postalCodes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.get: get_project +/dfareporting:v2.7/dfareporting.projects.get/id: id +/dfareporting:v2.7/dfareporting.projects.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.list: list_projects +/dfareporting:v2.7/dfareporting.projects.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.projects.list/ids: ids +/dfareporting:v2.7/dfareporting.projects.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.projects.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.projects.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.list/searchString: search_string +/dfareporting:v2.7/dfareporting.projects.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.projects.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.regions.list: list_regions +/dfareporting:v2.7/dfareporting.regions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.get: get_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.get/remarketingListId: remarketing_list_id +/dfareporting:v2.7/dfareporting.remarketingListShares.patch: patch_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.patch/remarketingListId: remarketing_list_id +/dfareporting:v2.7/dfareporting.remarketingListShares.update: update_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.get: get_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.get/id: id +/dfareporting:v2.7/dfareporting.remarketingLists.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.insert: insert_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.list: list_remarketing_lists +/dfareporting:v2.7/dfareporting.remarketingLists.list/active: active +/dfareporting:v2.7/dfareporting.remarketingLists.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.remarketingLists.list/name: name +/dfareporting:v2.7/dfareporting.remarketingLists.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.remarketingLists.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.remarketingLists.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.remarketingLists.patch: patch_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.patch/id: id +/dfareporting:v2.7/dfareporting.remarketingLists.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.update: update_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.delete: delete_report +/dfareporting:v2.7/dfareporting.reports.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.delete/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.get: get_report +/dfareporting:v2.7/dfareporting.reports.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.get/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.insert: insert_report +/dfareporting:v2.7/dfareporting.reports.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.list: list_reports +/dfareporting:v2.7/dfareporting.reports.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.reports.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.reports.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.list/scope: scope +/dfareporting:v2.7/dfareporting.reports.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.reports.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.reports.patch: patch_report +/dfareporting:v2.7/dfareporting.reports.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.patch/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.run: run_report +/dfareporting:v2.7/dfareporting.reports.run/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.run/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.run/synchronous: synchronous +/dfareporting:v2.7/dfareporting.reports.update: update_report +/dfareporting:v2.7/dfareporting.reports.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.update/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.compatibleFields.query: query_report_compatible_field +/dfareporting:v2.7/dfareporting.reports.compatibleFields.query/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.get: get_report_file +/dfareporting:v2.7/dfareporting.reports.files.get/fileId: file_id +/dfareporting:v2.7/dfareporting.reports.files.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.get/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.files.list: list_report_files +/dfareporting:v2.7/dfareporting.reports.files.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.reports.files.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.reports.files.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.list/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.files.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.reports.files.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.sites.get: get_site +/dfareporting:v2.7/dfareporting.sites.get/id: id +/dfareporting:v2.7/dfareporting.sites.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.insert: insert_site +/dfareporting:v2.7/dfareporting.sites.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.list: list_sites +/dfareporting:v2.7/dfareporting.sites.list/acceptsInStreamVideoPlacements: accepts_in_stream_video_placements +/dfareporting:v2.7/dfareporting.sites.list/acceptsInterstitialPlacements: accepts_interstitial_placements +/dfareporting:v2.7/dfareporting.sites.list/acceptsPublisherPaidPlacements: accepts_publisher_paid_placements +/dfareporting:v2.7/dfareporting.sites.list/adWordsSite: ad_words_site +/dfareporting:v2.7/dfareporting.sites.list/approved: approved +/dfareporting:v2.7/dfareporting.sites.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.sites.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.sites.list/ids: ids +/dfareporting:v2.7/dfareporting.sites.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.sites.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.sites.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.list/searchString: search_string +/dfareporting:v2.7/dfareporting.sites.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.sites.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.sites.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.sites.list/unmappedSite: unmapped_site +/dfareporting:v2.7/dfareporting.sites.patch: patch_site +/dfareporting:v2.7/dfareporting.sites.patch/id: id +/dfareporting:v2.7/dfareporting.sites.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.update: update_site +/dfareporting:v2.7/dfareporting.sites.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.get: get_size +/dfareporting:v2.7/dfareporting.sizes.get/id: id +/dfareporting:v2.7/dfareporting.sizes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.insert: insert_size +/dfareporting:v2.7/dfareporting.sizes.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.list: list_sizes +/dfareporting:v2.7/dfareporting.sizes.list/height: height +/dfareporting:v2.7/dfareporting.sizes.list/iabStandard: iab_standard +/dfareporting:v2.7/dfareporting.sizes.list/ids: ids +/dfareporting:v2.7/dfareporting.sizes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.list/width: width +/dfareporting:v2.7/dfareporting.subaccounts.get: get_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.get/id: id +/dfareporting:v2.7/dfareporting.subaccounts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.insert: insert_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.list: list_subaccounts +/dfareporting:v2.7/dfareporting.subaccounts.list/ids: ids +/dfareporting:v2.7/dfareporting.subaccounts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.subaccounts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.subaccounts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.subaccounts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.subaccounts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.subaccounts.patch: patch_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.patch/id: id +/dfareporting:v2.7/dfareporting.subaccounts.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.update: update_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get: get_targetable_remarketing_list +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get/id: id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list: list_targetable_remarketing_lists +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/active: active +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/name: name +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.targetingTemplates.get: get_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.get/id: id +/dfareporting:v2.7/dfareporting.targetingTemplates.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.insert: insert_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list: list_targeting_templates +/dfareporting:v2.7/dfareporting.targetingTemplates.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list/ids: ids +/dfareporting:v2.7/dfareporting.targetingTemplates.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.targetingTemplates.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.targetingTemplates.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list/searchString: search_string +/dfareporting:v2.7/dfareporting.targetingTemplates.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.targetingTemplates.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.targetingTemplates.patch: patch_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.patch/id: id +/dfareporting:v2.7/dfareporting.targetingTemplates.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.update: update_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.userProfiles.get: get_user_profile +/dfareporting:v2.7/dfareporting.userProfiles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userProfiles.list: list_user_profiles +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get: get_user_role_permission_group +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get/id: id +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.list: list_user_role_permission_groups +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissions.get: get_user_role_permission +/dfareporting:v2.7/dfareporting.userRolePermissions.get/id: id +/dfareporting:v2.7/dfareporting.userRolePermissions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissions.list: list_user_role_permissions +/dfareporting:v2.7/dfareporting.userRolePermissions.list/ids: ids +/dfareporting:v2.7/dfareporting.userRolePermissions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.delete: delete_user_role +/dfareporting:v2.7/dfareporting.userRoles.delete/id: id +/dfareporting:v2.7/dfareporting.userRoles.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.get: get_user_role +/dfareporting:v2.7/dfareporting.userRoles.get/id: id +/dfareporting:v2.7/dfareporting.userRoles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.insert: insert_user_role +/dfareporting:v2.7/dfareporting.userRoles.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.list: list_user_roles +/dfareporting:v2.7/dfareporting.userRoles.list/accountUserRoleOnly: account_user_role_only +/dfareporting:v2.7/dfareporting.userRoles.list/ids: ids +/dfareporting:v2.7/dfareporting.userRoles.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.userRoles.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.userRoles.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.list/searchString: search_string +/dfareporting:v2.7/dfareporting.userRoles.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.userRoles.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.userRoles.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.userRoles.patch: patch_user_role +/dfareporting:v2.7/dfareporting.userRoles.patch/id: id +/dfareporting:v2.7/dfareporting.userRoles.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.update: update_user_role +/dfareporting:v2.7/dfareporting.userRoles.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.videoFormats.get: get_video_format +/dfareporting:v2.7/dfareporting.videoFormats.get/id: id +/dfareporting:v2.7/dfareporting.videoFormats.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.videoFormats.list: list_video_formats +/dfareporting:v2.7/dfareporting.videoFormats.list/profileId: profile_id +/dfareporting:v2.7/Account: account +/dfareporting:v2.7/Account/accountPermissionIds: account_permission_ids +/dfareporting:v2.7/Account/accountPermissionIds/account_permission_id: account_permission_id +/dfareporting:v2.7/Account/accountProfile: account_profile +/dfareporting:v2.7/Account/active: active +/dfareporting:v2.7/Account/activeAdsLimitTier: active_ads_limit_tier +/dfareporting:v2.7/Account/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/Account/availablePermissionIds: available_permission_ids +/dfareporting:v2.7/Account/availablePermissionIds/available_permission_id: available_permission_id +/dfareporting:v2.7/Account/countryId: country_id +/dfareporting:v2.7/Account/currencyId: currency_id +/dfareporting:v2.7/Account/defaultCreativeSizeId: default_creative_size_id +/dfareporting:v2.7/Account/description: description +/dfareporting:v2.7/Account/id: id +/dfareporting:v2.7/Account/kind: kind +/dfareporting:v2.7/Account/locale: locale +/dfareporting:v2.7/Account/maximumImageSize: maximum_image_size +/dfareporting:v2.7/Account/name: name +/dfareporting:v2.7/Account/nielsenOcrEnabled: nielsen_ocr_enabled +/dfareporting:v2.7/Account/reportsConfiguration: reports_configuration +/dfareporting:v2.7/Account/shareReportsWithTwitter: share_reports_with_twitter +/dfareporting:v2.7/Account/teaserSizeLimit: teaser_size_limit +/dfareporting:v2.7/AccountActiveAdSummary: account_active_ad_summary +/dfareporting:v2.7/AccountActiveAdSummary/accountId: account_id +/dfareporting:v2.7/AccountActiveAdSummary/activeAds: active_ads +/dfareporting:v2.7/AccountActiveAdSummary/activeAdsLimitTier: active_ads_limit_tier +/dfareporting:v2.7/AccountActiveAdSummary/availableAds: available_ads +/dfareporting:v2.7/AccountActiveAdSummary/kind: kind +/dfareporting:v2.7/AccountPermission: account_permission +/dfareporting:v2.7/AccountPermission/accountProfiles: account_profiles +/dfareporting:v2.7/AccountPermission/accountProfiles/account_profile: account_profile +/dfareporting:v2.7/AccountPermission/id: id +/dfareporting:v2.7/AccountPermission/kind: kind +/dfareporting:v2.7/AccountPermission/level: level +/dfareporting:v2.7/AccountPermission/name: name +/dfareporting:v2.7/AccountPermission/permissionGroupId: permission_group_id +/dfareporting:v2.7/AccountPermissionGroup: account_permission_group +/dfareporting:v2.7/AccountPermissionGroup/id: id +/dfareporting:v2.7/AccountPermissionGroup/kind: kind +/dfareporting:v2.7/AccountPermissionGroup/name: name +/dfareporting:v2.7/AccountPermissionGroupsListResponse: account_permission_groups_list_response +/dfareporting:v2.7/AccountPermissionGroupsListResponse/accountPermissionGroups: account_permission_groups +/dfareporting:v2.7/AccountPermissionGroupsListResponse/accountPermissionGroups/account_permission_group: account_permission_group +/dfareporting:v2.7/AccountPermissionGroupsListResponse/kind: kind +/dfareporting:v2.7/AccountPermissionsListResponse: account_permissions_list_response +/dfareporting:v2.7/AccountPermissionsListResponse/accountPermissions: account_permissions +/dfareporting:v2.7/AccountPermissionsListResponse/accountPermissions/account_permission: account_permission +/dfareporting:v2.7/AccountPermissionsListResponse/kind: kind +/dfareporting:v2.7/AccountUserProfile: account_user_profile +/dfareporting:v2.7/AccountUserProfile/accountId: account_id +/dfareporting:v2.7/AccountUserProfile/active: active +/dfareporting:v2.7/AccountUserProfile/advertiserFilter: advertiser_filter +/dfareporting:v2.7/AccountUserProfile/campaignFilter: campaign_filter +/dfareporting:v2.7/AccountUserProfile/comments: comments +/dfareporting:v2.7/AccountUserProfile/email: email +/dfareporting:v2.7/AccountUserProfile/id: id +/dfareporting:v2.7/AccountUserProfile/kind: kind +/dfareporting:v2.7/AccountUserProfile/locale: locale +/dfareporting:v2.7/AccountUserProfile/name: name +/dfareporting:v2.7/AccountUserProfile/siteFilter: site_filter +/dfareporting:v2.7/AccountUserProfile/subaccountId: subaccount_id +/dfareporting:v2.7/AccountUserProfile/traffickerType: trafficker_type +/dfareporting:v2.7/AccountUserProfile/userAccessType: user_access_type +/dfareporting:v2.7/AccountUserProfile/userRoleFilter: user_role_filter +/dfareporting:v2.7/AccountUserProfile/userRoleId: user_role_id +/dfareporting:v2.7/AccountUserProfilesListResponse: account_user_profiles_list_response +/dfareporting:v2.7/AccountUserProfilesListResponse/accountUserProfiles: account_user_profiles +/dfareporting:v2.7/AccountUserProfilesListResponse/accountUserProfiles/account_user_profile: account_user_profile +/dfareporting:v2.7/AccountUserProfilesListResponse/kind: kind +/dfareporting:v2.7/AccountUserProfilesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AccountsListResponse: accounts_list_response +/dfareporting:v2.7/AccountsListResponse/accounts: accounts +/dfareporting:v2.7/AccountsListResponse/accounts/account: account +/dfareporting:v2.7/AccountsListResponse/kind: kind +/dfareporting:v2.7/AccountsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/Activities: activities +/dfareporting:v2.7/Activities/filters: filters +/dfareporting:v2.7/Activities/filters/filter: filter +/dfareporting:v2.7/Activities/kind: kind +/dfareporting:v2.7/Activities/metricNames: metric_names +/dfareporting:v2.7/Activities/metricNames/metric_name: metric_name +/dfareporting:v2.7/Ad: ad +/dfareporting:v2.7/Ad/accountId: account_id +/dfareporting:v2.7/Ad/active: active +/dfareporting:v2.7/Ad/advertiserId: advertiser_id +/dfareporting:v2.7/Ad/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Ad/archived: archived +/dfareporting:v2.7/Ad/audienceSegmentId: audience_segment_id +/dfareporting:v2.7/Ad/campaignId: campaign_id +/dfareporting:v2.7/Ad/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/Ad/clickThroughUrl: click_through_url +/dfareporting:v2.7/Ad/clickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/Ad/comments: comments +/dfareporting:v2.7/Ad/compatibility: compatibility +/dfareporting:v2.7/Ad/createInfo: create_info +/dfareporting:v2.7/Ad/creativeGroupAssignments: creative_group_assignments +/dfareporting:v2.7/Ad/creativeGroupAssignments/creative_group_assignment: creative_group_assignment +/dfareporting:v2.7/Ad/creativeRotation: creative_rotation +/dfareporting:v2.7/Ad/dayPartTargeting: day_part_targeting +/dfareporting:v2.7/Ad/defaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/Ad/deliverySchedule: delivery_schedule +/dfareporting:v2.7/Ad/dynamicClickTracker: dynamic_click_tracker +/dfareporting:v2.7/Ad/endTime: end_time +/dfareporting:v2.7/Ad/eventTagOverrides: event_tag_overrides +/dfareporting:v2.7/Ad/eventTagOverrides/event_tag_override: event_tag_override +/dfareporting:v2.7/Ad/geoTargeting: geo_targeting +/dfareporting:v2.7/Ad/id: id +/dfareporting:v2.7/Ad/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Ad/keyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/Ad/kind: kind +/dfareporting:v2.7/Ad/languageTargeting: language_targeting +/dfareporting:v2.7/Ad/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Ad/name: name +/dfareporting:v2.7/Ad/placementAssignments: placement_assignments +/dfareporting:v2.7/Ad/placementAssignments/placement_assignment: placement_assignment +/dfareporting:v2.7/Ad/remarketingListExpression: remarketing_list_expression +/dfareporting:v2.7/Ad/size: size +/dfareporting:v2.7/Ad/sslCompliant: ssl_compliant +/dfareporting:v2.7/Ad/sslRequired: ssl_required +/dfareporting:v2.7/Ad/startTime: start_time +/dfareporting:v2.7/Ad/subaccountId: subaccount_id +/dfareporting:v2.7/Ad/targetingTemplateId: targeting_template_id +/dfareporting:v2.7/Ad/technologyTargeting: technology_targeting +/dfareporting:v2.7/Ad/type: type +/dfareporting:v2.7/AdSlot: ad_slot +/dfareporting:v2.7/AdSlot/comment: comment +/dfareporting:v2.7/AdSlot/compatibility: compatibility +/dfareporting:v2.7/AdSlot/height: height +/dfareporting:v2.7/AdSlot/linkedPlacementId: linked_placement_id +/dfareporting:v2.7/AdSlot/name: name +/dfareporting:v2.7/AdSlot/paymentSourceType: payment_source_type +/dfareporting:v2.7/AdSlot/primary: primary +/dfareporting:v2.7/AdSlot/width: width +/dfareporting:v2.7/AdsListResponse: ads_list_response +/dfareporting:v2.7/AdsListResponse/ads: ads +/dfareporting:v2.7/AdsListResponse/ads/ad: ad +/dfareporting:v2.7/AdsListResponse/kind: kind +/dfareporting:v2.7/AdsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/Advertiser: advertiser +/dfareporting:v2.7/Advertiser/accountId: account_id +/dfareporting:v2.7/Advertiser/advertiserGroupId: advertiser_group_id +/dfareporting:v2.7/Advertiser/clickThroughUrlSuffix: click_through_url_suffix +/dfareporting:v2.7/Advertiser/defaultClickThroughEventTagId: default_click_through_event_tag_id +/dfareporting:v2.7/Advertiser/defaultEmail: default_email +/dfareporting:v2.7/Advertiser/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/Advertiser/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/Advertiser/id: id +/dfareporting:v2.7/Advertiser/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Advertiser/kind: kind +/dfareporting:v2.7/Advertiser/name: name +/dfareporting:v2.7/Advertiser/originalFloodlightConfigurationId: original_floodlight_configuration_id +/dfareporting:v2.7/Advertiser/status: status +/dfareporting:v2.7/Advertiser/subaccountId: subaccount_id +/dfareporting:v2.7/Advertiser/suspended: suspended +/dfareporting:v2.7/AdvertiserGroup: advertiser_group +/dfareporting:v2.7/AdvertiserGroup/accountId: account_id +/dfareporting:v2.7/AdvertiserGroup/id: id +/dfareporting:v2.7/AdvertiserGroup/kind: kind +/dfareporting:v2.7/AdvertiserGroup/name: name +/dfareporting:v2.7/AdvertiserGroupsListResponse: advertiser_groups_list_response +/dfareporting:v2.7/AdvertiserGroupsListResponse/advertiserGroups: advertiser_groups +/dfareporting:v2.7/AdvertiserGroupsListResponse/advertiserGroups/advertiser_group: advertiser_group +/dfareporting:v2.7/AdvertiserGroupsListResponse/kind: kind +/dfareporting:v2.7/AdvertiserGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AdvertisersListResponse: advertisers_list_response +/dfareporting:v2.7/AdvertisersListResponse/advertisers: advertisers +/dfareporting:v2.7/AdvertisersListResponse/advertisers/advertiser: advertiser +/dfareporting:v2.7/AdvertisersListResponse/kind: kind +/dfareporting:v2.7/AdvertisersListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AudienceSegment: audience_segment +/dfareporting:v2.7/AudienceSegment/allocation: allocation +/dfareporting:v2.7/AudienceSegment/id: id +/dfareporting:v2.7/AudienceSegment/name: name +/dfareporting:v2.7/AudienceSegmentGroup: audience_segment_group +/dfareporting:v2.7/AudienceSegmentGroup/audienceSegments: audience_segments +/dfareporting:v2.7/AudienceSegmentGroup/audienceSegments/audience_segment: audience_segment +/dfareporting:v2.7/AudienceSegmentGroup/id: id +/dfareporting:v2.7/AudienceSegmentGroup/name: name +/dfareporting:v2.7/Browser: browser +/dfareporting:v2.7/Browser/browserVersionId: browser_version_id +/dfareporting:v2.7/Browser/dartId: dart_id +/dfareporting:v2.7/Browser/kind: kind +/dfareporting:v2.7/Browser/majorVersion: major_version +/dfareporting:v2.7/Browser/minorVersion: minor_version +/dfareporting:v2.7/Browser/name: name +/dfareporting:v2.7/BrowsersListResponse: browsers_list_response +/dfareporting:v2.7/BrowsersListResponse/browsers: browsers +/dfareporting:v2.7/BrowsersListResponse/browsers/browser: browser +/dfareporting:v2.7/BrowsersListResponse/kind: kind +/dfareporting:v2.7/Campaign: campaign +/dfareporting:v2.7/Campaign/accountId: account_id +/dfareporting:v2.7/Campaign/additionalCreativeOptimizationConfigurations: additional_creative_optimization_configurations +/dfareporting:v2.7/Campaign/additionalCreativeOptimizationConfigurations/additional_creative_optimization_configuration: additional_creative_optimization_configuration +/dfareporting:v2.7/Campaign/advertiserGroupId: advertiser_group_id +/dfareporting:v2.7/Campaign/advertiserId: advertiser_id +/dfareporting:v2.7/Campaign/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Campaign/archived: archived +/dfareporting:v2.7/Campaign/audienceSegmentGroups: audience_segment_groups +/dfareporting:v2.7/Campaign/audienceSegmentGroups/audience_segment_group: audience_segment_group +/dfareporting:v2.7/Campaign/billingInvoiceCode: billing_invoice_code +/dfareporting:v2.7/Campaign/clickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/Campaign/comment: comment +/dfareporting:v2.7/Campaign/createInfo: create_info +/dfareporting:v2.7/Campaign/creativeGroupIds: creative_group_ids +/dfareporting:v2.7/Campaign/creativeGroupIds/creative_group_id: creative_group_id +/dfareporting:v2.7/Campaign/creativeOptimizationConfiguration: creative_optimization_configuration +/dfareporting:v2.7/Campaign/defaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/Campaign/endDate: end_date +/dfareporting:v2.7/Campaign/eventTagOverrides: event_tag_overrides +/dfareporting:v2.7/Campaign/eventTagOverrides/event_tag_override: event_tag_override +/dfareporting:v2.7/Campaign/externalId: external_id +/dfareporting:v2.7/Campaign/id: id +/dfareporting:v2.7/Campaign/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Campaign/kind: kind +/dfareporting:v2.7/Campaign/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Campaign/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/Campaign/name: name +/dfareporting:v2.7/Campaign/nielsenOcrEnabled: nielsen_ocr_enabled +/dfareporting:v2.7/Campaign/startDate: start_date +/dfareporting:v2.7/Campaign/subaccountId: subaccount_id +/dfareporting:v2.7/Campaign/traffickerEmails: trafficker_emails +/dfareporting:v2.7/Campaign/traffickerEmails/trafficker_email: trafficker_email +/dfareporting:v2.7/CampaignCreativeAssociation: campaign_creative_association +/dfareporting:v2.7/CampaignCreativeAssociation/creativeId: creative_id +/dfareporting:v2.7/CampaignCreativeAssociation/kind: kind +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse: campaign_creative_associations_list_response +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations: campaign_creative_associations +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations/campaign_creative_association: campaign_creative_association +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/kind: kind +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CampaignsListResponse: campaigns_list_response +/dfareporting:v2.7/CampaignsListResponse/campaigns: campaigns +/dfareporting:v2.7/CampaignsListResponse/campaigns/campaign: campaign +/dfareporting:v2.7/CampaignsListResponse/kind: kind +/dfareporting:v2.7/CampaignsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ChangeLog: change_log +/dfareporting:v2.7/ChangeLog/accountId: account_id +/dfareporting:v2.7/ChangeLog/action: action +/dfareporting:v2.7/ChangeLog/changeTime: change_time +/dfareporting:v2.7/ChangeLog/fieldName: field_name +/dfareporting:v2.7/ChangeLog/id: id +/dfareporting:v2.7/ChangeLog/kind: kind +/dfareporting:v2.7/ChangeLog/newValue: new_value +/dfareporting:v2.7/ChangeLog/objectId: object_id_prop +/dfareporting:v2.7/ChangeLog/objectType: object_type +/dfareporting:v2.7/ChangeLog/oldValue: old_value +/dfareporting:v2.7/ChangeLog/subaccountId: subaccount_id +/dfareporting:v2.7/ChangeLog/transactionId: transaction_id +/dfareporting:v2.7/ChangeLog/userProfileId: user_profile_id +/dfareporting:v2.7/ChangeLog/userProfileName: user_profile_name +/dfareporting:v2.7/ChangeLogsListResponse: change_logs_list_response +/dfareporting:v2.7/ChangeLogsListResponse/changeLogs: change_logs +/dfareporting:v2.7/ChangeLogsListResponse/changeLogs/change_log: change_log +/dfareporting:v2.7/ChangeLogsListResponse/kind: kind +/dfareporting:v2.7/ChangeLogsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CitiesListResponse: cities_list_response +/dfareporting:v2.7/CitiesListResponse/cities: cities +/dfareporting:v2.7/CitiesListResponse/cities/city: city +/dfareporting:v2.7/CitiesListResponse/kind: kind +/dfareporting:v2.7/City: city +/dfareporting:v2.7/City/countryCode: country_code +/dfareporting:v2.7/City/countryDartId: country_dart_id +/dfareporting:v2.7/City/dartId: dart_id +/dfareporting:v2.7/City/kind: kind +/dfareporting:v2.7/City/metroCode: metro_code +/dfareporting:v2.7/City/metroDmaId: metro_dma_id +/dfareporting:v2.7/City/name: name +/dfareporting:v2.7/City/regionCode: region_code +/dfareporting:v2.7/City/regionDartId: region_dart_id +/dfareporting:v2.7/ClickTag: click_tag +/dfareporting:v2.7/ClickTag/eventName: event_name +/dfareporting:v2.7/ClickTag/name: name +/dfareporting:v2.7/ClickTag/value: value +/dfareporting:v2.7/ClickThroughUrl: click_through_url +/dfareporting:v2.7/ClickThroughUrl/computedClickThroughUrl: computed_click_through_url +/dfareporting:v2.7/ClickThroughUrl/customClickThroughUrl: custom_click_through_url +/dfareporting:v2.7/ClickThroughUrl/defaultLandingPage: default_landing_page +/dfareporting:v2.7/ClickThroughUrl/landingPageId: landing_page_id +/dfareporting:v2.7/ClickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/ClickThroughUrlSuffixProperties/clickThroughUrlSuffix: click_through_url_suffix +/dfareporting:v2.7/ClickThroughUrlSuffixProperties/overrideInheritedSuffix: override_inherited_suffix +/dfareporting:v2.7/CompanionClickThroughOverride: companion_click_through_override +/dfareporting:v2.7/CompanionClickThroughOverride/clickThroughUrl: click_through_url +/dfareporting:v2.7/CompanionClickThroughOverride/creativeId: creative_id +/dfareporting:v2.7/CompanionSetting: companion_setting +/dfareporting:v2.7/CompanionSetting/companionsDisabled: companions_disabled +/dfareporting:v2.7/CompanionSetting/enabledSizes: enabled_sizes +/dfareporting:v2.7/CompanionSetting/enabledSizes/enabled_size: enabled_size +/dfareporting:v2.7/CompanionSetting/imageOnly: image_only +/dfareporting:v2.7/CompanionSetting/kind: kind +/dfareporting:v2.7/CompatibleFields: compatible_fields +/dfareporting:v2.7/CompatibleFields/crossDimensionReachReportCompatibleFields: cross_dimension_reach_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/floodlightReportCompatibleFields: floodlight_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/kind: kind +/dfareporting:v2.7/CompatibleFields/pathToConversionReportCompatibleFields: path_to_conversion_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/reachReportCompatibleFields: reach_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/reportCompatibleFields: report_compatible_fields +/dfareporting:v2.7/ConnectionType: connection_type +/dfareporting:v2.7/ConnectionType/id: id +/dfareporting:v2.7/ConnectionType/kind: kind +/dfareporting:v2.7/ConnectionType/name: name +/dfareporting:v2.7/ConnectionTypesListResponse: connection_types_list_response +/dfareporting:v2.7/ConnectionTypesListResponse/connectionTypes: connection_types +/dfareporting:v2.7/ConnectionTypesListResponse/connectionTypes/connection_type: connection_type +/dfareporting:v2.7/ConnectionTypesListResponse/kind: kind +/dfareporting:v2.7/ContentCategoriesListResponse: content_categories_list_response +/dfareporting:v2.7/ContentCategoriesListResponse/contentCategories: content_categories +/dfareporting:v2.7/ContentCategoriesListResponse/contentCategories/content_category: content_category +/dfareporting:v2.7/ContentCategoriesListResponse/kind: kind +/dfareporting:v2.7/ContentCategoriesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ContentCategory: content_category +/dfareporting:v2.7/ContentCategory/accountId: account_id +/dfareporting:v2.7/ContentCategory/id: id +/dfareporting:v2.7/ContentCategory/kind: kind +/dfareporting:v2.7/ContentCategory/name: name +/dfareporting:v2.7/Conversion: conversion +/dfareporting:v2.7/Conversion/childDirectedTreatment: child_directed_treatment +/dfareporting:v2.7/Conversion/customVariables: custom_variables +/dfareporting:v2.7/Conversion/customVariables/custom_variable: custom_variable +/dfareporting:v2.7/Conversion/encryptedUserId: encrypted_user_id +/dfareporting:v2.7/Conversion/encryptedUserIdCandidates: encrypted_user_id_candidates +/dfareporting:v2.7/Conversion/encryptedUserIdCandidates/encrypted_user_id_candidate: encrypted_user_id_candidate +/dfareporting:v2.7/Conversion/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/Conversion/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/Conversion/kind: kind +/dfareporting:v2.7/Conversion/limitAdTracking: limit_ad_tracking +/dfareporting:v2.7/Conversion/mobileDeviceId: mobile_device_id +/dfareporting:v2.7/Conversion/ordinal: ordinal +/dfareporting:v2.7/Conversion/quantity: quantity +/dfareporting:v2.7/Conversion/timestampMicros: timestamp_micros +/dfareporting:v2.7/Conversion/value: value +/dfareporting:v2.7/ConversionError: conversion_error +/dfareporting:v2.7/ConversionError/code: code +/dfareporting:v2.7/ConversionError/kind: kind +/dfareporting:v2.7/ConversionError/message: message +/dfareporting:v2.7/ConversionStatus: conversion_status +/dfareporting:v2.7/ConversionStatus/conversion: conversion +/dfareporting:v2.7/ConversionStatus/errors: errors +/dfareporting:v2.7/ConversionStatus/errors/error: error +/dfareporting:v2.7/ConversionStatus/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertRequest: conversions_batch_insert_request +/dfareporting:v2.7/ConversionsBatchInsertRequest/conversions: conversions +/dfareporting:v2.7/ConversionsBatchInsertRequest/conversions/conversion: conversion +/dfareporting:v2.7/ConversionsBatchInsertRequest/encryptionInfo: encryption_info +/dfareporting:v2.7/ConversionsBatchInsertRequest/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertResponse: conversions_batch_insert_response +/dfareporting:v2.7/ConversionsBatchInsertResponse/hasFailures: has_failures +/dfareporting:v2.7/ConversionsBatchInsertResponse/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertResponse/status: status +/dfareporting:v2.7/ConversionsBatchInsertResponse/status/status: status +/dfareporting:v2.7/CountriesListResponse: countries_list_response +/dfareporting:v2.7/CountriesListResponse/countries: countries +/dfareporting:v2.7/CountriesListResponse/countries/country: country +/dfareporting:v2.7/CountriesListResponse/kind: kind +/dfareporting:v2.7/Country: country +/dfareporting:v2.7/Country/countryCode: country_code +/dfareporting:v2.7/Country/dartId: dart_id +/dfareporting:v2.7/Country/kind: kind +/dfareporting:v2.7/Country/name: name +/dfareporting:v2.7/Country/sslEnabled: ssl_enabled +/dfareporting:v2.7/Creative: creative +/dfareporting:v2.7/Creative/accountId: account_id +/dfareporting:v2.7/Creative/active: active +/dfareporting:v2.7/Creative/adParameters: ad_parameters +/dfareporting:v2.7/Creative/adTagKeys: ad_tag_keys +/dfareporting:v2.7/Creative/adTagKeys/ad_tag_key: ad_tag_key +/dfareporting:v2.7/Creative/advertiserId: advertiser_id +/dfareporting:v2.7/Creative/allowScriptAccess: allow_script_access +/dfareporting:v2.7/Creative/archived: archived +/dfareporting:v2.7/Creative/artworkType: artwork_type +/dfareporting:v2.7/Creative/authoringSource: authoring_source +/dfareporting:v2.7/Creative/authoringTool: authoring_tool +/dfareporting:v2.7/Creative/auto_advance_images: auto_advance_images +/dfareporting:v2.7/Creative/backgroundColor: background_color +/dfareporting:v2.7/Creative/backupImageClickThroughUrl: backup_image_click_through_url +/dfareporting:v2.7/Creative/backupImageFeatures: backup_image_features +/dfareporting:v2.7/Creative/backupImageFeatures/backup_image_feature: backup_image_feature +/dfareporting:v2.7/Creative/backupImageReportingLabel: backup_image_reporting_label +/dfareporting:v2.7/Creative/backupImageTargetWindow: backup_image_target_window +/dfareporting:v2.7/Creative/clickTags: click_tags +/dfareporting:v2.7/Creative/clickTags/click_tag: click_tag +/dfareporting:v2.7/Creative/commercialId: commercial_id +/dfareporting:v2.7/Creative/companionCreatives: companion_creatives +/dfareporting:v2.7/Creative/companionCreatives/companion_creative: companion_creative +/dfareporting:v2.7/Creative/compatibility: compatibility +/dfareporting:v2.7/Creative/compatibility/compatibility: compatibility +/dfareporting:v2.7/Creative/convertFlashToHtml5: convert_flash_to_html5 +/dfareporting:v2.7/Creative/counterCustomEvents: counter_custom_events +/dfareporting:v2.7/Creative/counterCustomEvents/counter_custom_event: counter_custom_event +/dfareporting:v2.7/Creative/creativeAssetSelection: creative_asset_selection +/dfareporting:v2.7/Creative/creativeAssets: creative_assets +/dfareporting:v2.7/Creative/creativeAssets/creative_asset: creative_asset +/dfareporting:v2.7/Creative/creativeFieldAssignments: creative_field_assignments +/dfareporting:v2.7/Creative/creativeFieldAssignments/creative_field_assignment: creative_field_assignment +/dfareporting:v2.7/Creative/customKeyValues: custom_key_values +/dfareporting:v2.7/Creative/customKeyValues/custom_key_value: custom_key_value +/dfareporting:v2.7/Creative/dynamicAssetSelection: dynamic_asset_selection +/dfareporting:v2.7/Creative/exitCustomEvents: exit_custom_events +/dfareporting:v2.7/Creative/exitCustomEvents/exit_custom_event: exit_custom_event +/dfareporting:v2.7/Creative/fsCommand: fs_command +/dfareporting:v2.7/Creative/htmlCode: html_code +/dfareporting:v2.7/Creative/htmlCodeLocked: html_code_locked +/dfareporting:v2.7/Creative/id: id +/dfareporting:v2.7/Creative/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Creative/kind: kind +/dfareporting:v2.7/Creative/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Creative/latestTraffickedCreativeId: latest_trafficked_creative_id +/dfareporting:v2.7/Creative/name: name +/dfareporting:v2.7/Creative/overrideCss: override_css +/dfareporting:v2.7/Creative/progressOffset: progress_offset +/dfareporting:v2.7/Creative/redirectUrl: redirect_url +/dfareporting:v2.7/Creative/renderingId: rendering_id +/dfareporting:v2.7/Creative/renderingIdDimensionValue: rendering_id_dimension_value +/dfareporting:v2.7/Creative/requiredFlashPluginVersion: required_flash_plugin_version +/dfareporting:v2.7/Creative/requiredFlashVersion: required_flash_version +/dfareporting:v2.7/Creative/size: size +/dfareporting:v2.7/Creative/skipOffset: skip_offset +/dfareporting:v2.7/Creative/skippable: skippable +/dfareporting:v2.7/Creative/sslCompliant: ssl_compliant +/dfareporting:v2.7/Creative/sslOverride: ssl_override +/dfareporting:v2.7/Creative/studioAdvertiserId: studio_advertiser_id +/dfareporting:v2.7/Creative/studioCreativeId: studio_creative_id +/dfareporting:v2.7/Creative/studioTraffickedCreativeId: studio_trafficked_creative_id +/dfareporting:v2.7/Creative/subaccountId: subaccount_id +/dfareporting:v2.7/Creative/thirdPartyBackupImageImpressionsUrl: third_party_backup_image_impressions_url +/dfareporting:v2.7/Creative/thirdPartyRichMediaImpressionsUrl: third_party_rich_media_impressions_url +/dfareporting:v2.7/Creative/thirdPartyUrls: third_party_urls +/dfareporting:v2.7/Creative/thirdPartyUrls/third_party_url: third_party_url +/dfareporting:v2.7/Creative/timerCustomEvents: timer_custom_events +/dfareporting:v2.7/Creative/timerCustomEvents/timer_custom_event: timer_custom_event +/dfareporting:v2.7/Creative/totalFileSize: total_file_size +/dfareporting:v2.7/Creative/type: type +/dfareporting:v2.7/Creative/version: version +/dfareporting:v2.7/Creative/videoDescription: video_description +/dfareporting:v2.7/Creative/videoDuration: video_duration +/dfareporting:v2.7/CreativeAsset: creative_asset +/dfareporting:v2.7/CreativeAsset/actionScript3: action_script3 +/dfareporting:v2.7/CreativeAsset/active: active +/dfareporting:v2.7/CreativeAsset/alignment: alignment +/dfareporting:v2.7/CreativeAsset/artworkType: artwork_type +/dfareporting:v2.7/CreativeAsset/assetIdentifier: asset_identifier +/dfareporting:v2.7/CreativeAsset/backupImageExit: backup_image_exit +/dfareporting:v2.7/CreativeAsset/bitRate: bit_rate +/dfareporting:v2.7/CreativeAsset/childAssetType: child_asset_type +/dfareporting:v2.7/CreativeAsset/collapsedSize: collapsed_size +/dfareporting:v2.7/CreativeAsset/companionCreativeIds: companion_creative_ids +/dfareporting:v2.7/CreativeAsset/companionCreativeIds/companion_creative_id: companion_creative_id +/dfareporting:v2.7/CreativeAsset/customStartTimeValue: custom_start_time_value +/dfareporting:v2.7/CreativeAsset/detectedFeatures: detected_features +/dfareporting:v2.7/CreativeAsset/detectedFeatures/detected_feature: detected_feature +/dfareporting:v2.7/CreativeAsset/displayType: display_type +/dfareporting:v2.7/CreativeAsset/duration: duration +/dfareporting:v2.7/CreativeAsset/durationType: duration_type +/dfareporting:v2.7/CreativeAsset/expandedDimension: expanded_dimension +/dfareporting:v2.7/CreativeAsset/fileSize: file_size +/dfareporting:v2.7/CreativeAsset/flashVersion: flash_version +/dfareporting:v2.7/CreativeAsset/hideFlashObjects: hide_flash_objects +/dfareporting:v2.7/CreativeAsset/hideSelectionBoxes: hide_selection_boxes +/dfareporting:v2.7/CreativeAsset/horizontallyLocked: horizontally_locked +/dfareporting:v2.7/CreativeAsset/id: id +/dfareporting:v2.7/CreativeAsset/idDimensionValue: id_dimension_value +/dfareporting:v2.7/CreativeAsset/mimeType: mime_type +/dfareporting:v2.7/CreativeAsset/offset: offset +/dfareporting:v2.7/CreativeAsset/originalBackup: original_backup +/dfareporting:v2.7/CreativeAsset/position: position +/dfareporting:v2.7/CreativeAsset/positionLeftUnit: position_left_unit +/dfareporting:v2.7/CreativeAsset/positionTopUnit: position_top_unit +/dfareporting:v2.7/CreativeAsset/progressiveServingUrl: progressive_serving_url +/dfareporting:v2.7/CreativeAsset/pushdown: pushdown +/dfareporting:v2.7/CreativeAsset/pushdownDuration: pushdown_duration +/dfareporting:v2.7/CreativeAsset/role: role +/dfareporting:v2.7/CreativeAsset/size: size +/dfareporting:v2.7/CreativeAsset/sslCompliant: ssl_compliant +/dfareporting:v2.7/CreativeAsset/startTimeType: start_time_type +/dfareporting:v2.7/CreativeAsset/streamingServingUrl: streaming_serving_url +/dfareporting:v2.7/CreativeAsset/transparency: transparency +/dfareporting:v2.7/CreativeAsset/verticallyLocked: vertically_locked +/dfareporting:v2.7/CreativeAsset/videoDuration: video_duration +/dfareporting:v2.7/CreativeAsset/windowMode: window_mode +/dfareporting:v2.7/CreativeAsset/zIndex: z_index +/dfareporting:v2.7/CreativeAsset/zipFilename: zip_filename +/dfareporting:v2.7/CreativeAsset/zipFilesize: zip_filesize +/dfareporting:v2.7/CreativeAssetId: creative_asset_id +/dfareporting:v2.7/CreativeAssetId/name: name +/dfareporting:v2.7/CreativeAssetId/type: type +/dfareporting:v2.7/CreativeAssetMetadata: creative_asset_metadata +/dfareporting:v2.7/CreativeAssetMetadata/assetIdentifier: asset_identifier +/dfareporting:v2.7/CreativeAssetMetadata/clickTags: click_tags +/dfareporting:v2.7/CreativeAssetMetadata/clickTags/click_tag: click_tag +/dfareporting:v2.7/CreativeAssetMetadata/detectedFeatures: detected_features +/dfareporting:v2.7/CreativeAssetMetadata/detectedFeatures/detected_feature: detected_feature +/dfareporting:v2.7/CreativeAssetMetadata/id: id +/dfareporting:v2.7/CreativeAssetMetadata/idDimensionValue: id_dimension_value +/dfareporting:v2.7/CreativeAssetMetadata/kind: kind +/dfareporting:v2.7/CreativeAssetMetadata/warnedValidationRules: warned_validation_rules +/dfareporting:v2.7/CreativeAssetMetadata/warnedValidationRules/warned_validation_rule: warned_validation_rule +/dfareporting:v2.7/CreativeAssetSelection: creative_asset_selection +/dfareporting:v2.7/CreativeAssetSelection/defaultAssetId: default_asset_id +/dfareporting:v2.7/CreativeAssetSelection/rules: rules +/dfareporting:v2.7/CreativeAssetSelection/rules/rule: rule +/dfareporting:v2.7/CreativeAssignment: creative_assignment +/dfareporting:v2.7/CreativeAssignment/active: active +/dfareporting:v2.7/CreativeAssignment/applyEventTags: apply_event_tags +/dfareporting:v2.7/CreativeAssignment/clickThroughUrl: click_through_url +/dfareporting:v2.7/CreativeAssignment/companionCreativeOverrides: companion_creative_overrides +/dfareporting:v2.7/CreativeAssignment/companionCreativeOverrides/companion_creative_override: companion_creative_override +/dfareporting:v2.7/CreativeAssignment/creativeGroupAssignments: creative_group_assignments +/dfareporting:v2.7/CreativeAssignment/creativeGroupAssignments/creative_group_assignment: creative_group_assignment +/dfareporting:v2.7/CreativeAssignment/creativeId: creative_id +/dfareporting:v2.7/CreativeAssignment/creativeIdDimensionValue: creative_id_dimension_value +/dfareporting:v2.7/CreativeAssignment/endTime: end_time +/dfareporting:v2.7/CreativeAssignment/richMediaExitOverrides: rich_media_exit_overrides +/dfareporting:v2.7/CreativeAssignment/richMediaExitOverrides/rich_media_exit_override: rich_media_exit_override +/dfareporting:v2.7/CreativeAssignment/sequence: sequence +/dfareporting:v2.7/CreativeAssignment/sslCompliant: ssl_compliant +/dfareporting:v2.7/CreativeAssignment/startTime: start_time +/dfareporting:v2.7/CreativeAssignment/weight: weight +/dfareporting:v2.7/CreativeCustomEvent: creative_custom_event +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventId: advertiser_custom_event_id +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventName: advertiser_custom_event_name +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventType: advertiser_custom_event_type +/dfareporting:v2.7/CreativeCustomEvent/artworkLabel: artwork_label +/dfareporting:v2.7/CreativeCustomEvent/artworkType: artwork_type +/dfareporting:v2.7/CreativeCustomEvent/exitUrl: exit_url +/dfareporting:v2.7/CreativeCustomEvent/id: id +/dfareporting:v2.7/CreativeCustomEvent/popupWindowProperties: popup_window_properties +/dfareporting:v2.7/CreativeCustomEvent/targetType: target_type +/dfareporting:v2.7/CreativeCustomEvent/videoReportingId: video_reporting_id +/dfareporting:v2.7/CreativeField: creative_field +/dfareporting:v2.7/CreativeField/accountId: account_id +/dfareporting:v2.7/CreativeField/advertiserId: advertiser_id +/dfareporting:v2.7/CreativeField/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/CreativeField/id: id +/dfareporting:v2.7/CreativeField/kind: kind +/dfareporting:v2.7/CreativeField/name: name +/dfareporting:v2.7/CreativeField/subaccountId: subaccount_id +/dfareporting:v2.7/CreativeFieldAssignment: creative_field_assignment +/dfareporting:v2.7/CreativeFieldAssignment/creativeFieldId: creative_field_id +/dfareporting:v2.7/CreativeFieldAssignment/creativeFieldValueId: creative_field_value_id +/dfareporting:v2.7/CreativeFieldValue: creative_field_value +/dfareporting:v2.7/CreativeFieldValue/id: id +/dfareporting:v2.7/CreativeFieldValue/kind: kind +/dfareporting:v2.7/CreativeFieldValue/value: value +/dfareporting:v2.7/CreativeFieldValuesListResponse: creative_field_values_list_response +/dfareporting:v2.7/CreativeFieldValuesListResponse/creativeFieldValues: creative_field_values +/dfareporting:v2.7/CreativeFieldValuesListResponse/creativeFieldValues/creative_field_value: creative_field_value +/dfareporting:v2.7/CreativeFieldValuesListResponse/kind: kind +/dfareporting:v2.7/CreativeFieldValuesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeFieldsListResponse: creative_fields_list_response +/dfareporting:v2.7/CreativeFieldsListResponse/creativeFields: creative_fields +/dfareporting:v2.7/CreativeFieldsListResponse/creativeFields/creative_field: creative_field +/dfareporting:v2.7/CreativeFieldsListResponse/kind: kind +/dfareporting:v2.7/CreativeFieldsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeGroup: creative_group +/dfareporting:v2.7/CreativeGroup/accountId: account_id +/dfareporting:v2.7/CreativeGroup/advertiserId: advertiser_id +/dfareporting:v2.7/CreativeGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/CreativeGroup/groupNumber: group_number +/dfareporting:v2.7/CreativeGroup/id: id +/dfareporting:v2.7/CreativeGroup/kind: kind +/dfareporting:v2.7/CreativeGroup/name: name +/dfareporting:v2.7/CreativeGroup/subaccountId: subaccount_id +/dfareporting:v2.7/CreativeGroupAssignment: creative_group_assignment +/dfareporting:v2.7/CreativeGroupAssignment/creativeGroupId: creative_group_id +/dfareporting:v2.7/CreativeGroupAssignment/creativeGroupNumber: creative_group_number +/dfareporting:v2.7/CreativeGroupsListResponse: creative_groups_list_response +/dfareporting:v2.7/CreativeGroupsListResponse/creativeGroups: creative_groups +/dfareporting:v2.7/CreativeGroupsListResponse/creativeGroups/creative_group: creative_group +/dfareporting:v2.7/CreativeGroupsListResponse/kind: kind +/dfareporting:v2.7/CreativeGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeOptimizationConfiguration: creative_optimization_configuration +/dfareporting:v2.7/CreativeOptimizationConfiguration/id: id +/dfareporting:v2.7/CreativeOptimizationConfiguration/name: name +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationActivitys: optimization_activitys +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationActivitys/optimization_activity: optimization_activity +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationModel: optimization_model +/dfareporting:v2.7/CreativeRotation: creative_rotation +/dfareporting:v2.7/CreativeRotation/creativeAssignments: creative_assignments +/dfareporting:v2.7/CreativeRotation/creativeAssignments/creative_assignment: creative_assignment +/dfareporting:v2.7/CreativeRotation/creativeOptimizationConfigurationId: creative_optimization_configuration_id +/dfareporting:v2.7/CreativeRotation/type: type +/dfareporting:v2.7/CreativeRotation/weightCalculationStrategy: weight_calculation_strategy +/dfareporting:v2.7/CreativeSettings: creative_settings +/dfareporting:v2.7/CreativeSettings/iFrameFooter: i_frame_footer +/dfareporting:v2.7/CreativeSettings/iFrameHeader: i_frame_header +/dfareporting:v2.7/CreativesListResponse: creatives_list_response +/dfareporting:v2.7/CreativesListResponse/creatives: creatives +/dfareporting:v2.7/CreativesListResponse/creatives/creative: creative +/dfareporting:v2.7/CreativesListResponse/kind: kind +/dfareporting:v2.7/CreativesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields: cross_dimension_reach_report_compatible_fields +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/breakdown: breakdown +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/breakdown/breakdown: breakdown +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/kind: kind +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/overlapMetrics: overlap_metrics +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/overlapMetrics/overlap_metric: overlap_metric +/dfareporting:v2.7/CustomFloodlightVariable: custom_floodlight_variable +/dfareporting:v2.7/CustomFloodlightVariable/kind: kind +/dfareporting:v2.7/CustomFloodlightVariable/type: type +/dfareporting:v2.7/CustomFloodlightVariable/value: value +/dfareporting:v2.7/CustomRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/CustomRichMediaEvents/filteredEventIds: filtered_event_ids +/dfareporting:v2.7/CustomRichMediaEvents/filteredEventIds/filtered_event_id: filtered_event_id +/dfareporting:v2.7/CustomRichMediaEvents/kind: kind +/dfareporting:v2.7/DateRange: date_range +/dfareporting:v2.7/DateRange/endDate: end_date +/dfareporting:v2.7/DateRange/kind: kind +/dfareporting:v2.7/DateRange/relativeDateRange: relative_date_range +/dfareporting:v2.7/DateRange/startDate: start_date +/dfareporting:v2.7/DayPartTargeting: day_part_targeting +/dfareporting:v2.7/DayPartTargeting/daysOfWeek: days_of_week +/dfareporting:v2.7/DayPartTargeting/daysOfWeek/days_of_week: days_of_week +/dfareporting:v2.7/DayPartTargeting/hoursOfDay: hours_of_day +/dfareporting:v2.7/DayPartTargeting/hoursOfDay/hours_of_day: hours_of_day +/dfareporting:v2.7/DayPartTargeting/userLocalTime: user_local_time +/dfareporting:v2.7/DefaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/DefaultClickThroughEventTagProperties/defaultClickThroughEventTagId: default_click_through_event_tag_id +/dfareporting:v2.7/DefaultClickThroughEventTagProperties/overrideInheritedEventTag: override_inherited_event_tag +/dfareporting:v2.7/DeliverySchedule: delivery_schedule +/dfareporting:v2.7/DeliverySchedule/frequencyCap: frequency_cap +/dfareporting:v2.7/DeliverySchedule/hardCutoff: hard_cutoff +/dfareporting:v2.7/DeliverySchedule/impressionRatio: impression_ratio +/dfareporting:v2.7/DeliverySchedule/priority: priority +/dfareporting:v2.7/DfpSettings: dfp_settings +/dfareporting:v2.7/DfpSettings/dfp_network_code: dfp_network_code +/dfareporting:v2.7/DfpSettings/dfp_network_name: dfp_network_name +/dfareporting:v2.7/DfpSettings/programmaticPlacementAccepted: programmatic_placement_accepted +/dfareporting:v2.7/DfpSettings/pubPaidPlacementAccepted: pub_paid_placement_accepted +/dfareporting:v2.7/DfpSettings/publisherPortalOnly: publisher_portal_only +/dfareporting:v2.7/Dimension: dimension +/dfareporting:v2.7/Dimension/kind: kind +/dfareporting:v2.7/Dimension/name: name +/dfareporting:v2.7/DimensionFilter: dimension_filter +/dfareporting:v2.7/DimensionFilter/dimensionName: dimension_name +/dfareporting:v2.7/DimensionFilter/kind: kind +/dfareporting:v2.7/DimensionFilter/value: value +/dfareporting:v2.7/DimensionValue: dimension_value +/dfareporting:v2.7/DimensionValue/dimensionName: dimension_name +/dfareporting:v2.7/DimensionValue/etag: etag +/dfareporting:v2.7/DimensionValue/id: id +/dfareporting:v2.7/DimensionValue/kind: kind +/dfareporting:v2.7/DimensionValue/matchType: match_type +/dfareporting:v2.7/DimensionValue/value: value +/dfareporting:v2.7/DimensionValueList: dimension_value_list +/dfareporting:v2.7/DimensionValueList/etag: etag +/dfareporting:v2.7/DimensionValueList/items: items +/dfareporting:v2.7/DimensionValueList/items/item: item +/dfareporting:v2.7/DimensionValueList/kind: kind +/dfareporting:v2.7/DimensionValueList/nextPageToken: next_page_token +/dfareporting:v2.7/DimensionValueRequest: dimension_value_request +/dfareporting:v2.7/DimensionValueRequest/dimensionName: dimension_name +/dfareporting:v2.7/DimensionValueRequest/endDate: end_date +/dfareporting:v2.7/DimensionValueRequest/filters: filters +/dfareporting:v2.7/DimensionValueRequest/filters/filter: filter +/dfareporting:v2.7/DimensionValueRequest/kind: kind +/dfareporting:v2.7/DimensionValueRequest/startDate: start_date +/dfareporting:v2.7/DirectorySite: directory_site +/dfareporting:v2.7/DirectorySite/active: active +/dfareporting:v2.7/DirectorySite/contactAssignments: contact_assignments +/dfareporting:v2.7/DirectorySite/contactAssignments/contact_assignment: contact_assignment +/dfareporting:v2.7/DirectorySite/countryId: country_id +/dfareporting:v2.7/DirectorySite/currencyId: currency_id +/dfareporting:v2.7/DirectorySite/description: description +/dfareporting:v2.7/DirectorySite/id: id +/dfareporting:v2.7/DirectorySite/idDimensionValue: id_dimension_value +/dfareporting:v2.7/DirectorySite/inpageTagFormats: inpage_tag_formats +/dfareporting:v2.7/DirectorySite/inpageTagFormats/inpage_tag_format: inpage_tag_format +/dfareporting:v2.7/DirectorySite/interstitialTagFormats: interstitial_tag_formats +/dfareporting:v2.7/DirectorySite/interstitialTagFormats/interstitial_tag_format: interstitial_tag_format +/dfareporting:v2.7/DirectorySite/kind: kind +/dfareporting:v2.7/DirectorySite/name: name +/dfareporting:v2.7/DirectorySite/parentId: parent_id +/dfareporting:v2.7/DirectorySite/settings: settings +/dfareporting:v2.7/DirectorySite/url: url +/dfareporting:v2.7/DirectorySiteContact: directory_site_contact +/dfareporting:v2.7/DirectorySiteContact/address: address +/dfareporting:v2.7/DirectorySiteContact/email: email +/dfareporting:v2.7/DirectorySiteContact/firstName: first_name +/dfareporting:v2.7/DirectorySiteContact/id: id +/dfareporting:v2.7/DirectorySiteContact/kind: kind +/dfareporting:v2.7/DirectorySiteContact/lastName: last_name +/dfareporting:v2.7/DirectorySiteContact/phone: phone +/dfareporting:v2.7/DirectorySiteContact/role: role +/dfareporting:v2.7/DirectorySiteContact/title: title +/dfareporting:v2.7/DirectorySiteContact/type: type +/dfareporting:v2.7/DirectorySiteContactAssignment: directory_site_contact_assignment +/dfareporting:v2.7/DirectorySiteContactAssignment/contactId: contact_id +/dfareporting:v2.7/DirectorySiteContactAssignment/visibility: visibility +/dfareporting:v2.7/DirectorySiteContactsListResponse: directory_site_contacts_list_response +/dfareporting:v2.7/DirectorySiteContactsListResponse/directorySiteContacts: directory_site_contacts +/dfareporting:v2.7/DirectorySiteContactsListResponse/directorySiteContacts/directory_site_contact: directory_site_contact +/dfareporting:v2.7/DirectorySiteContactsListResponse/kind: kind +/dfareporting:v2.7/DirectorySiteContactsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/DirectorySiteSettings: directory_site_settings +/dfareporting:v2.7/DirectorySiteSettings/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/DirectorySiteSettings/dfp_settings: dfp_settings +/dfareporting:v2.7/DirectorySiteSettings/instream_video_placement_accepted: instream_video_placement_accepted +/dfareporting:v2.7/DirectorySiteSettings/interstitialPlacementAccepted: interstitial_placement_accepted +/dfareporting:v2.7/DirectorySiteSettings/nielsenOcrOptOut: nielsen_ocr_opt_out +/dfareporting:v2.7/DirectorySiteSettings/verificationTagOptOut: verification_tag_opt_out +/dfareporting:v2.7/DirectorySiteSettings/videoActiveViewOptOut: video_active_view_opt_out +/dfareporting:v2.7/DirectorySitesListResponse: directory_sites_list_response +/dfareporting:v2.7/DirectorySitesListResponse/directorySites: directory_sites +/dfareporting:v2.7/DirectorySitesListResponse/directorySites/directory_site: directory_site +/dfareporting:v2.7/DirectorySitesListResponse/kind: kind +/dfareporting:v2.7/DirectorySitesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/DynamicTargetingKey: dynamic_targeting_key +/dfareporting:v2.7/DynamicTargetingKey/kind: kind +/dfareporting:v2.7/DynamicTargetingKey/name: name +/dfareporting:v2.7/DynamicTargetingKey/objectId: object_id_prop +/dfareporting:v2.7/DynamicTargetingKey/objectType: object_type +/dfareporting:v2.7/DynamicTargetingKeysListResponse: dynamic_targeting_keys_list_response +/dfareporting:v2.7/DynamicTargetingKeysListResponse/dynamicTargetingKeys: dynamic_targeting_keys +/dfareporting:v2.7/DynamicTargetingKeysListResponse/dynamicTargetingKeys/dynamic_targeting_key: dynamic_targeting_key +/dfareporting:v2.7/DynamicTargetingKeysListResponse/kind: kind +/dfareporting:v2.7/EncryptionInfo: encryption_info +/dfareporting:v2.7/EncryptionInfo/encryptionEntityId: encryption_entity_id +/dfareporting:v2.7/EncryptionInfo/encryptionEntityType: encryption_entity_type +/dfareporting:v2.7/EncryptionInfo/encryptionSource: encryption_source +/dfareporting:v2.7/EncryptionInfo/kind: kind +/dfareporting:v2.7/EventTag: event_tag +/dfareporting:v2.7/EventTag/accountId: account_id +/dfareporting:v2.7/EventTag/advertiserId: advertiser_id +/dfareporting:v2.7/EventTag/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/EventTag/campaignId: campaign_id +/dfareporting:v2.7/EventTag/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/EventTag/enabledByDefault: enabled_by_default +/dfareporting:v2.7/EventTag/excludeFromAdxRequests: exclude_from_adx_requests +/dfareporting:v2.7/EventTag/id: id +/dfareporting:v2.7/EventTag/kind: kind +/dfareporting:v2.7/EventTag/name: name +/dfareporting:v2.7/EventTag/siteFilterType: site_filter_type +/dfareporting:v2.7/EventTag/siteIds: site_ids +/dfareporting:v2.7/EventTag/siteIds/site_id: site_id +/dfareporting:v2.7/EventTag/sslCompliant: ssl_compliant +/dfareporting:v2.7/EventTag/status: status +/dfareporting:v2.7/EventTag/subaccountId: subaccount_id +/dfareporting:v2.7/EventTag/type: type +/dfareporting:v2.7/EventTag/url: url +/dfareporting:v2.7/EventTag/urlEscapeLevels: url_escape_levels +/dfareporting:v2.7/EventTagOverride: event_tag_override +/dfareporting:v2.7/EventTagOverride/enabled: enabled +/dfareporting:v2.7/EventTagOverride/id: id +/dfareporting:v2.7/EventTagsListResponse: event_tags_list_response +/dfareporting:v2.7/EventTagsListResponse/eventTags: event_tags +/dfareporting:v2.7/EventTagsListResponse/eventTags/event_tag: event_tag +/dfareporting:v2.7/EventTagsListResponse/kind: kind +/dfareporting:v2.7/File: file +/dfareporting:v2.7/File/dateRange: date_range +/dfareporting:v2.7/File/etag: etag +/dfareporting:v2.7/File/fileName: file_name +/dfareporting:v2.7/File/format: format +/dfareporting:v2.7/File/id: id +/dfareporting:v2.7/File/kind: kind +/dfareporting:v2.7/File/lastModifiedTime: last_modified_time +/dfareporting:v2.7/File/reportId: report_id +/dfareporting:v2.7/File/status: status +/dfareporting:v2.7/File/urls: urls +/dfareporting:v2.7/File/urls/apiUrl: api_url +/dfareporting:v2.7/File/urls/browserUrl: browser_url +/dfareporting:v2.7/FileList: file_list +/dfareporting:v2.7/FileList/etag: etag +/dfareporting:v2.7/FileList/items: items +/dfareporting:v2.7/FileList/items/item: item +/dfareporting:v2.7/FileList/kind: kind +/dfareporting:v2.7/FileList/nextPageToken: next_page_token +/dfareporting:v2.7/Flight: flight +/dfareporting:v2.7/Flight/endDate: end_date +/dfareporting:v2.7/Flight/rateOrCost: rate_or_cost +/dfareporting:v2.7/Flight/startDate: start_date +/dfareporting:v2.7/Flight/units: units +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse: floodlight_activities_generate_tag_response +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse/floodlightActivityTag: floodlight_activity_tag +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse/kind: kind +/dfareporting:v2.7/FloodlightActivitiesListResponse: floodlight_activities_list_response +/dfareporting:v2.7/FloodlightActivitiesListResponse/floodlightActivities: floodlight_activities +/dfareporting:v2.7/FloodlightActivitiesListResponse/floodlightActivities/floodlight_activity: floodlight_activity +/dfareporting:v2.7/FloodlightActivitiesListResponse/kind: kind +/dfareporting:v2.7/FloodlightActivitiesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/FloodlightActivity: floodlight_activity +/dfareporting:v2.7/FloodlightActivity/accountId: account_id +/dfareporting:v2.7/FloodlightActivity/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightActivity/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightActivity/cacheBustingType: cache_busting_type +/dfareporting:v2.7/FloodlightActivity/countingMethod: counting_method +/dfareporting:v2.7/FloodlightActivity/defaultTags: default_tags +/dfareporting:v2.7/FloodlightActivity/defaultTags/default_tag: default_tag +/dfareporting:v2.7/FloodlightActivity/expectedUrl: expected_url +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupId: floodlight_activity_group_id +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupName: floodlight_activity_group_name +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupTagString: floodlight_activity_group_tag_string +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupType: floodlight_activity_group_type +/dfareporting:v2.7/FloodlightActivity/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/FloodlightActivity/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/FloodlightActivity/hidden: hidden +/dfareporting:v2.7/FloodlightActivity/id: id +/dfareporting:v2.7/FloodlightActivity/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightActivity/imageTagEnabled: image_tag_enabled +/dfareporting:v2.7/FloodlightActivity/kind: kind +/dfareporting:v2.7/FloodlightActivity/name: name +/dfareporting:v2.7/FloodlightActivity/notes: notes +/dfareporting:v2.7/FloodlightActivity/publisherTags: publisher_tags +/dfareporting:v2.7/FloodlightActivity/publisherTags/publisher_tag: publisher_tag +/dfareporting:v2.7/FloodlightActivity/secure: secure +/dfareporting:v2.7/FloodlightActivity/sslCompliant: ssl_compliant +/dfareporting:v2.7/FloodlightActivity/sslRequired: ssl_required +/dfareporting:v2.7/FloodlightActivity/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightActivity/tagFormat: tag_format +/dfareporting:v2.7/FloodlightActivity/tagString: tag_string +/dfareporting:v2.7/FloodlightActivity/userDefinedVariableTypes: user_defined_variable_types +/dfareporting:v2.7/FloodlightActivity/userDefinedVariableTypes/user_defined_variable_type: user_defined_variable_type +/dfareporting:v2.7/FloodlightActivityDynamicTag: floodlight_activity_dynamic_tag +/dfareporting:v2.7/FloodlightActivityDynamicTag/id: id +/dfareporting:v2.7/FloodlightActivityDynamicTag/name: name +/dfareporting:v2.7/FloodlightActivityDynamicTag/tag: tag +/dfareporting:v2.7/FloodlightActivityGroup: floodlight_activity_group +/dfareporting:v2.7/FloodlightActivityGroup/accountId: account_id +/dfareporting:v2.7/FloodlightActivityGroup/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightActivityGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/FloodlightActivityGroup/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/id: id +/dfareporting:v2.7/FloodlightActivityGroup/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/kind: kind +/dfareporting:v2.7/FloodlightActivityGroup/name: name +/dfareporting:v2.7/FloodlightActivityGroup/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightActivityGroup/tagString: tag_string +/dfareporting:v2.7/FloodlightActivityGroup/type: type +/dfareporting:v2.7/FloodlightActivityGroupsListResponse: floodlight_activity_groups_list_response +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/floodlightActivityGroups: floodlight_activity_groups +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/floodlightActivityGroups/floodlight_activity_group: floodlight_activity_group +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/kind: kind +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag: floodlight_activity_publisher_dynamic_tag +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/clickThrough: click_through +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/directorySiteId: directory_site_id +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/dynamicTag: dynamic_tag +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/siteId: site_id +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/viewThrough: view_through +/dfareporting:v2.7/FloodlightConfiguration: floodlight_configuration +/dfareporting:v2.7/FloodlightConfiguration/accountId: account_id +/dfareporting:v2.7/FloodlightConfiguration/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightConfiguration/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightConfiguration/analyticsDataSharingEnabled: analytics_data_sharing_enabled +/dfareporting:v2.7/FloodlightConfiguration/exposureToConversionEnabled: exposure_to_conversion_enabled +/dfareporting:v2.7/FloodlightConfiguration/firstDayOfWeek: first_day_of_week +/dfareporting:v2.7/FloodlightConfiguration/id: id +/dfareporting:v2.7/FloodlightConfiguration/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightConfiguration/inAppAttributionTrackingEnabled: in_app_attribution_tracking_enabled +/dfareporting:v2.7/FloodlightConfiguration/kind: kind +/dfareporting:v2.7/FloodlightConfiguration/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/FloodlightConfiguration/naturalSearchConversionAttributionOption: natural_search_conversion_attribution_option +/dfareporting:v2.7/FloodlightConfiguration/omnitureSettings: omniture_settings +/dfareporting:v2.7/FloodlightConfiguration/standardVariableTypes: standard_variable_types +/dfareporting:v2.7/FloodlightConfiguration/standardVariableTypes/standard_variable_type: standard_variable_type +/dfareporting:v2.7/FloodlightConfiguration/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightConfiguration/tagSettings: tag_settings +/dfareporting:v2.7/FloodlightConfiguration/thirdPartyAuthenticationTokens: third_party_authentication_tokens +/dfareporting:v2.7/FloodlightConfiguration/thirdPartyAuthenticationTokens/third_party_authentication_token: third_party_authentication_token +/dfareporting:v2.7/FloodlightConfiguration/userDefinedVariableConfigurations: user_defined_variable_configurations +/dfareporting:v2.7/FloodlightConfiguration/userDefinedVariableConfigurations/user_defined_variable_configuration: user_defined_variable_configuration +/dfareporting:v2.7/FloodlightConfigurationsListResponse: floodlight_configurations_list_response +/dfareporting:v2.7/FloodlightConfigurationsListResponse/floodlightConfigurations: floodlight_configurations +/dfareporting:v2.7/FloodlightConfigurationsListResponse/floodlightConfigurations/floodlight_configuration: floodlight_configuration +/dfareporting:v2.7/FloodlightConfigurationsListResponse/kind: kind +/dfareporting:v2.7/FloodlightReportCompatibleFields: floodlight_report_compatible_fields +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/FloodlightReportCompatibleFields/kind: kind +/dfareporting:v2.7/FloodlightReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/FloodlightReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/FrequencyCap: frequency_cap +/dfareporting:v2.7/FrequencyCap/duration: duration +/dfareporting:v2.7/FrequencyCap/impressions: impressions +/dfareporting:v2.7/FsCommand: fs_command +/dfareporting:v2.7/FsCommand/left: left +/dfareporting:v2.7/FsCommand/positionOption: position_option +/dfareporting:v2.7/FsCommand/top: top +/dfareporting:v2.7/FsCommand/windowHeight: window_height +/dfareporting:v2.7/FsCommand/windowWidth: window_width +/dfareporting:v2.7/GeoTargeting: geo_targeting +/dfareporting:v2.7/GeoTargeting/cities: cities +/dfareporting:v2.7/GeoTargeting/cities/city: city +/dfareporting:v2.7/GeoTargeting/countries: countries +/dfareporting:v2.7/GeoTargeting/countries/country: country +/dfareporting:v2.7/GeoTargeting/excludeCountries: exclude_countries +/dfareporting:v2.7/GeoTargeting/metros: metros +/dfareporting:v2.7/GeoTargeting/metros/metro: metro +/dfareporting:v2.7/GeoTargeting/postalCodes: postal_codes +/dfareporting:v2.7/GeoTargeting/postalCodes/postal_code: postal_code +/dfareporting:v2.7/GeoTargeting/regions: regions +/dfareporting:v2.7/GeoTargeting/regions/region: region +/dfareporting:v2.7/InventoryItem: inventory_item +/dfareporting:v2.7/InventoryItem/accountId: account_id +/dfareporting:v2.7/InventoryItem/adSlots: ad_slots +/dfareporting:v2.7/InventoryItem/adSlots/ad_slot: ad_slot +/dfareporting:v2.7/InventoryItem/advertiserId: advertiser_id +/dfareporting:v2.7/InventoryItem/contentCategoryId: content_category_id +/dfareporting:v2.7/InventoryItem/estimatedClickThroughRate: estimated_click_through_rate +/dfareporting:v2.7/InventoryItem/estimatedConversionRate: estimated_conversion_rate +/dfareporting:v2.7/InventoryItem/id: id +/dfareporting:v2.7/InventoryItem/inPlan: in_plan +/dfareporting:v2.7/InventoryItem/kind: kind +/dfareporting:v2.7/InventoryItem/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/InventoryItem/name: name +/dfareporting:v2.7/InventoryItem/negotiationChannelId: negotiation_channel_id +/dfareporting:v2.7/InventoryItem/orderId: order_id +/dfareporting:v2.7/InventoryItem/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/InventoryItem/pricing: pricing +/dfareporting:v2.7/InventoryItem/projectId: project_id +/dfareporting:v2.7/InventoryItem/rfpId: rfp_id +/dfareporting:v2.7/InventoryItem/siteId: site_id +/dfareporting:v2.7/InventoryItem/subaccountId: subaccount_id +/dfareporting:v2.7/InventoryItem/type: type +/dfareporting:v2.7/InventoryItemsListResponse: inventory_items_list_response +/dfareporting:v2.7/InventoryItemsListResponse/inventoryItems: inventory_items +/dfareporting:v2.7/InventoryItemsListResponse/inventoryItems/inventory_item: inventory_item +/dfareporting:v2.7/InventoryItemsListResponse/kind: kind +/dfareporting:v2.7/InventoryItemsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/KeyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/KeyValueTargetingExpression/expression: expression +/dfareporting:v2.7/LandingPage: landing_page +/dfareporting:v2.7/LandingPage/default: default +/dfareporting:v2.7/LandingPage/id: id +/dfareporting:v2.7/LandingPage/kind: kind +/dfareporting:v2.7/LandingPage/name: name +/dfareporting:v2.7/LandingPage/url: url +/dfareporting:v2.7/LandingPagesListResponse: landing_pages_list_response +/dfareporting:v2.7/LandingPagesListResponse/kind: kind +/dfareporting:v2.7/LandingPagesListResponse/landingPages: landing_pages +/dfareporting:v2.7/LandingPagesListResponse/landingPages/landing_page: landing_page +/dfareporting:v2.7/Language: language +/dfareporting:v2.7/Language/id: id +/dfareporting:v2.7/Language/kind: kind +/dfareporting:v2.7/Language/languageCode: language_code +/dfareporting:v2.7/Language/name: name +/dfareporting:v2.7/LanguageTargeting: language_targeting +/dfareporting:v2.7/LanguageTargeting/languages: languages +/dfareporting:v2.7/LanguageTargeting/languages/language: language +/dfareporting:v2.7/LanguagesListResponse: languages_list_response +/dfareporting:v2.7/LanguagesListResponse/kind: kind +/dfareporting:v2.7/LanguagesListResponse/languages: languages +/dfareporting:v2.7/LanguagesListResponse/languages/language: language +/dfareporting:v2.7/LastModifiedInfo: last_modified_info +/dfareporting:v2.7/LastModifiedInfo/time: time +/dfareporting:v2.7/ListPopulationClause: list_population_clause +/dfareporting:v2.7/ListPopulationClause/terms: terms +/dfareporting:v2.7/ListPopulationClause/terms/term: term +/dfareporting:v2.7/ListPopulationRule: list_population_rule +/dfareporting:v2.7/ListPopulationRule/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/ListPopulationRule/floodlightActivityName: floodlight_activity_name +/dfareporting:v2.7/ListPopulationRule/listPopulationClauses: list_population_clauses +/dfareporting:v2.7/ListPopulationRule/listPopulationClauses/list_population_clause: list_population_clause +/dfareporting:v2.7/ListPopulationTerm: list_population_term +/dfareporting:v2.7/ListPopulationTerm/contains: contains +/dfareporting:v2.7/ListPopulationTerm/negation: negation +/dfareporting:v2.7/ListPopulationTerm/operator: operator +/dfareporting:v2.7/ListPopulationTerm/remarketingListId: remarketing_list_id +/dfareporting:v2.7/ListPopulationTerm/type: type +/dfareporting:v2.7/ListPopulationTerm/value: value +/dfareporting:v2.7/ListPopulationTerm/variableFriendlyName: variable_friendly_name +/dfareporting:v2.7/ListPopulationTerm/variableName: variable_name +/dfareporting:v2.7/ListTargetingExpression: list_targeting_expression +/dfareporting:v2.7/ListTargetingExpression/expression: expression +/dfareporting:v2.7/LookbackConfiguration: lookback_configuration +/dfareporting:v2.7/LookbackConfiguration/clickDuration: click_duration +/dfareporting:v2.7/LookbackConfiguration/postImpressionActivitiesDuration: post_impression_activities_duration +/dfareporting:v2.7/Metric: metric +/dfareporting:v2.7/Metric/kind: kind +/dfareporting:v2.7/Metric/name: name +/dfareporting:v2.7/Metro: metro +/dfareporting:v2.7/Metro/countryCode: country_code +/dfareporting:v2.7/Metro/countryDartId: country_dart_id +/dfareporting:v2.7/Metro/dartId: dart_id +/dfareporting:v2.7/Metro/dmaId: dma_id +/dfareporting:v2.7/Metro/kind: kind +/dfareporting:v2.7/Metro/metroCode: metro_code +/dfareporting:v2.7/Metro/name: name +/dfareporting:v2.7/MetrosListResponse: metros_list_response +/dfareporting:v2.7/MetrosListResponse/kind: kind +/dfareporting:v2.7/MetrosListResponse/metros: metros +/dfareporting:v2.7/MetrosListResponse/metros/metro: metro +/dfareporting:v2.7/MobileCarrier: mobile_carrier +/dfareporting:v2.7/MobileCarrier/countryCode: country_code +/dfareporting:v2.7/MobileCarrier/countryDartId: country_dart_id +/dfareporting:v2.7/MobileCarrier/id: id +/dfareporting:v2.7/MobileCarrier/kind: kind +/dfareporting:v2.7/MobileCarrier/name: name +/dfareporting:v2.7/MobileCarriersListResponse: mobile_carriers_list_response +/dfareporting:v2.7/MobileCarriersListResponse/kind: kind +/dfareporting:v2.7/MobileCarriersListResponse/mobileCarriers: mobile_carriers +/dfareporting:v2.7/MobileCarriersListResponse/mobileCarriers/mobile_carrier: mobile_carrier +/dfareporting:v2.7/ObjectFilter: object_filter +/dfareporting:v2.7/ObjectFilter/kind: kind +/dfareporting:v2.7/ObjectFilter/objectIds: object_ids +/dfareporting:v2.7/ObjectFilter/objectIds/object_id: object_id_prop +/dfareporting:v2.7/ObjectFilter/status: status +/dfareporting:v2.7/OffsetPosition: offset_position +/dfareporting:v2.7/OffsetPosition/left: left +/dfareporting:v2.7/OffsetPosition/top: top +/dfareporting:v2.7/OmnitureSettings: omniture_settings +/dfareporting:v2.7/OmnitureSettings/omnitureCostDataEnabled: omniture_cost_data_enabled +/dfareporting:v2.7/OmnitureSettings/omnitureIntegrationEnabled: omniture_integration_enabled +/dfareporting:v2.7/OperatingSystem: operating_system +/dfareporting:v2.7/OperatingSystem/dartId: dart_id +/dfareporting:v2.7/OperatingSystem/desktop: desktop +/dfareporting:v2.7/OperatingSystem/kind: kind +/dfareporting:v2.7/OperatingSystem/mobile: mobile +/dfareporting:v2.7/OperatingSystem/name: name +/dfareporting:v2.7/OperatingSystemVersion: operating_system_version +/dfareporting:v2.7/OperatingSystemVersion/id: id +/dfareporting:v2.7/OperatingSystemVersion/kind: kind +/dfareporting:v2.7/OperatingSystemVersion/majorVersion: major_version +/dfareporting:v2.7/OperatingSystemVersion/minorVersion: minor_version +/dfareporting:v2.7/OperatingSystemVersion/name: name +/dfareporting:v2.7/OperatingSystemVersion/operatingSystem: operating_system +/dfareporting:v2.7/OperatingSystemVersionsListResponse: operating_system_versions_list_response +/dfareporting:v2.7/OperatingSystemVersionsListResponse/kind: kind +/dfareporting:v2.7/OperatingSystemVersionsListResponse/operatingSystemVersions: operating_system_versions +/dfareporting:v2.7/OperatingSystemVersionsListResponse/operatingSystemVersions/operating_system_version: operating_system_version +/dfareporting:v2.7/OperatingSystemsListResponse: operating_systems_list_response +/dfareporting:v2.7/OperatingSystemsListResponse/kind: kind +/dfareporting:v2.7/OperatingSystemsListResponse/operatingSystems: operating_systems +/dfareporting:v2.7/OperatingSystemsListResponse/operatingSystems/operating_system: operating_system +/dfareporting:v2.7/OptimizationActivity: optimization_activity +/dfareporting:v2.7/OptimizationActivity/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/OptimizationActivity/floodlightActivityIdDimensionValue: floodlight_activity_id_dimension_value +/dfareporting:v2.7/OptimizationActivity/weight: weight +/dfareporting:v2.7/Order: order +/dfareporting:v2.7/Order/accountId: account_id +/dfareporting:v2.7/Order/advertiserId: advertiser_id +/dfareporting:v2.7/Order/approverUserProfileIds: approver_user_profile_ids +/dfareporting:v2.7/Order/approverUserProfileIds/approver_user_profile_id: approver_user_profile_id +/dfareporting:v2.7/Order/buyerInvoiceId: buyer_invoice_id +/dfareporting:v2.7/Order/buyerOrganizationName: buyer_organization_name +/dfareporting:v2.7/Order/comments: comments +/dfareporting:v2.7/Order/contacts: contacts +/dfareporting:v2.7/Order/contacts/contact: contact +/dfareporting:v2.7/Order/id: id +/dfareporting:v2.7/Order/kind: kind +/dfareporting:v2.7/Order/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Order/name: name +/dfareporting:v2.7/Order/notes: notes +/dfareporting:v2.7/Order/planningTermId: planning_term_id +/dfareporting:v2.7/Order/projectId: project_id +/dfareporting:v2.7/Order/sellerOrderId: seller_order_id +/dfareporting:v2.7/Order/sellerOrganizationName: seller_organization_name +/dfareporting:v2.7/Order/siteId: site_id +/dfareporting:v2.7/Order/siteId/site_id: site_id +/dfareporting:v2.7/Order/siteNames: site_names +/dfareporting:v2.7/Order/siteNames/site_name: site_name +/dfareporting:v2.7/Order/subaccountId: subaccount_id +/dfareporting:v2.7/Order/termsAndConditions: terms_and_conditions +/dfareporting:v2.7/OrderContact: order_contact +/dfareporting:v2.7/OrderContact/contactInfo: contact_info +/dfareporting:v2.7/OrderContact/contactName: contact_name +/dfareporting:v2.7/OrderContact/contactTitle: contact_title +/dfareporting:v2.7/OrderContact/contactType: contact_type +/dfareporting:v2.7/OrderContact/signatureUserProfileId: signature_user_profile_id +/dfareporting:v2.7/OrderDocument: order_document +/dfareporting:v2.7/OrderDocument/accountId: account_id +/dfareporting:v2.7/OrderDocument/advertiserId: advertiser_id +/dfareporting:v2.7/OrderDocument/amendedOrderDocumentId: amended_order_document_id +/dfareporting:v2.7/OrderDocument/approvedByUserProfileIds: approved_by_user_profile_ids +/dfareporting:v2.7/OrderDocument/approvedByUserProfileIds/approved_by_user_profile_id: approved_by_user_profile_id +/dfareporting:v2.7/OrderDocument/cancelled: cancelled +/dfareporting:v2.7/OrderDocument/createdInfo: created_info +/dfareporting:v2.7/OrderDocument/effectiveDate: effective_date +/dfareporting:v2.7/OrderDocument/id: id +/dfareporting:v2.7/OrderDocument/kind: kind +/dfareporting:v2.7/OrderDocument/lastSentRecipients: last_sent_recipients +/dfareporting:v2.7/OrderDocument/lastSentRecipients/last_sent_recipient: last_sent_recipient +/dfareporting:v2.7/OrderDocument/lastSentTime: last_sent_time +/dfareporting:v2.7/OrderDocument/orderId: order_id +/dfareporting:v2.7/OrderDocument/projectId: project_id +/dfareporting:v2.7/OrderDocument/signed: signed +/dfareporting:v2.7/OrderDocument/subaccountId: subaccount_id +/dfareporting:v2.7/OrderDocument/title: title +/dfareporting:v2.7/OrderDocument/type: type +/dfareporting:v2.7/OrderDocumentsListResponse: order_documents_list_response +/dfareporting:v2.7/OrderDocumentsListResponse/kind: kind +/dfareporting:v2.7/OrderDocumentsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/OrderDocumentsListResponse/orderDocuments: order_documents +/dfareporting:v2.7/OrderDocumentsListResponse/orderDocuments/order_document: order_document +/dfareporting:v2.7/OrdersListResponse: orders_list_response +/dfareporting:v2.7/OrdersListResponse/kind: kind +/dfareporting:v2.7/OrdersListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/OrdersListResponse/orders: orders +/dfareporting:v2.7/OrdersListResponse/orders/order: order +/dfareporting:v2.7/PathToConversionReportCompatibleFields: path_to_conversion_report_compatible_fields +/dfareporting:v2.7/PathToConversionReportCompatibleFields/conversionDimensions: conversion_dimensions +/dfareporting:v2.7/PathToConversionReportCompatibleFields/conversionDimensions/conversion_dimension: conversion_dimension +/dfareporting:v2.7/PathToConversionReportCompatibleFields/customFloodlightVariables: custom_floodlight_variables +/dfareporting:v2.7/PathToConversionReportCompatibleFields/customFloodlightVariables/custom_floodlight_variable: custom_floodlight_variable +/dfareporting:v2.7/PathToConversionReportCompatibleFields/kind: kind +/dfareporting:v2.7/PathToConversionReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/PathToConversionReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/PathToConversionReportCompatibleFields/perInteractionDimensions: per_interaction_dimensions +/dfareporting:v2.7/PathToConversionReportCompatibleFields/perInteractionDimensions/per_interaction_dimension: per_interaction_dimension +/dfareporting:v2.7/Placement: placement +/dfareporting:v2.7/Placement/accountId: account_id +/dfareporting:v2.7/Placement/advertiserId: advertiser_id +/dfareporting:v2.7/Placement/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Placement/archived: archived +/dfareporting:v2.7/Placement/campaignId: campaign_id +/dfareporting:v2.7/Placement/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/Placement/comment: comment +/dfareporting:v2.7/Placement/compatibility: compatibility +/dfareporting:v2.7/Placement/contentCategoryId: content_category_id +/dfareporting:v2.7/Placement/createInfo: create_info +/dfareporting:v2.7/Placement/directorySiteId: directory_site_id +/dfareporting:v2.7/Placement/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/Placement/externalId: external_id +/dfareporting:v2.7/Placement/id: id +/dfareporting:v2.7/Placement/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Placement/keyName: key_name +/dfareporting:v2.7/Placement/kind: kind +/dfareporting:v2.7/Placement/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Placement/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/Placement/name: name +/dfareporting:v2.7/Placement/paymentApproved: payment_approved +/dfareporting:v2.7/Placement/paymentSource: payment_source +/dfareporting:v2.7/Placement/placementGroupId: placement_group_id +/dfareporting:v2.7/Placement/placementGroupIdDimensionValue: placement_group_id_dimension_value +/dfareporting:v2.7/Placement/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/Placement/pricingSchedule: pricing_schedule +/dfareporting:v2.7/Placement/primary: primary +/dfareporting:v2.7/Placement/publisherUpdateInfo: publisher_update_info +/dfareporting:v2.7/Placement/siteId: site_id +/dfareporting:v2.7/Placement/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/Placement/size: size +/dfareporting:v2.7/Placement/sslRequired: ssl_required +/dfareporting:v2.7/Placement/status: status +/dfareporting:v2.7/Placement/subaccountId: subaccount_id +/dfareporting:v2.7/Placement/tagFormats: tag_formats +/dfareporting:v2.7/Placement/tagFormats/tag_format: tag_format +/dfareporting:v2.7/Placement/tagSetting: tag_setting +/dfareporting:v2.7/Placement/videoActiveViewOptOut: video_active_view_opt_out +/dfareporting:v2.7/Placement/videoSettings: video_settings +/dfareporting:v2.7/Placement/vpaidAdapterChoice: vpaid_adapter_choice +/dfareporting:v2.7/PlacementAssignment: placement_assignment +/dfareporting:v2.7/PlacementAssignment/active: active +/dfareporting:v2.7/PlacementAssignment/placementId: placement_id +/dfareporting:v2.7/PlacementAssignment/placementIdDimensionValue: placement_id_dimension_value +/dfareporting:v2.7/PlacementAssignment/sslRequired: ssl_required +/dfareporting:v2.7/PlacementGroup: placement_group +/dfareporting:v2.7/PlacementGroup/accountId: account_id +/dfareporting:v2.7/PlacementGroup/advertiserId: advertiser_id +/dfareporting:v2.7/PlacementGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/PlacementGroup/archived: archived +/dfareporting:v2.7/PlacementGroup/campaignId: campaign_id +/dfareporting:v2.7/PlacementGroup/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/PlacementGroup/childPlacementIds: child_placement_ids +/dfareporting:v2.7/PlacementGroup/childPlacementIds/child_placement_id: child_placement_id +/dfareporting:v2.7/PlacementGroup/comment: comment +/dfareporting:v2.7/PlacementGroup/contentCategoryId: content_category_id +/dfareporting:v2.7/PlacementGroup/createInfo: create_info +/dfareporting:v2.7/PlacementGroup/directorySiteId: directory_site_id +/dfareporting:v2.7/PlacementGroup/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/PlacementGroup/externalId: external_id +/dfareporting:v2.7/PlacementGroup/id: id +/dfareporting:v2.7/PlacementGroup/idDimensionValue: id_dimension_value +/dfareporting:v2.7/PlacementGroup/kind: kind +/dfareporting:v2.7/PlacementGroup/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/PlacementGroup/name: name +/dfareporting:v2.7/PlacementGroup/placementGroupType: placement_group_type +/dfareporting:v2.7/PlacementGroup/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/PlacementGroup/pricingSchedule: pricing_schedule +/dfareporting:v2.7/PlacementGroup/primaryPlacementId: primary_placement_id +/dfareporting:v2.7/PlacementGroup/primaryPlacementIdDimensionValue: primary_placement_id_dimension_value +/dfareporting:v2.7/PlacementGroup/siteId: site_id +/dfareporting:v2.7/PlacementGroup/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/PlacementGroup/subaccountId: subaccount_id +/dfareporting:v2.7/PlacementGroupsListResponse: placement_groups_list_response +/dfareporting:v2.7/PlacementGroupsListResponse/kind: kind +/dfareporting:v2.7/PlacementGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementGroupsListResponse/placementGroups: placement_groups +/dfareporting:v2.7/PlacementGroupsListResponse/placementGroups/placement_group: placement_group +/dfareporting:v2.7/PlacementStrategiesListResponse: placement_strategies_list_response +/dfareporting:v2.7/PlacementStrategiesListResponse/kind: kind +/dfareporting:v2.7/PlacementStrategiesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementStrategiesListResponse/placementStrategies: placement_strategies +/dfareporting:v2.7/PlacementStrategiesListResponse/placementStrategies/placement_strategy: placement_strategy +/dfareporting:v2.7/PlacementStrategy: placement_strategy +/dfareporting:v2.7/PlacementStrategy/accountId: account_id +/dfareporting:v2.7/PlacementStrategy/id: id +/dfareporting:v2.7/PlacementStrategy/kind: kind +/dfareporting:v2.7/PlacementStrategy/name: name +/dfareporting:v2.7/PlacementTag: placement_tag +/dfareporting:v2.7/PlacementTag/placementId: placement_id +/dfareporting:v2.7/PlacementTag/tagDatas: tag_datas +/dfareporting:v2.7/PlacementTag/tagDatas/tag_data: tag_data +/dfareporting:v2.7/PlacementsGenerateTagsResponse: placements_generate_tags_response +/dfareporting:v2.7/PlacementsGenerateTagsResponse/kind: kind +/dfareporting:v2.7/PlacementsGenerateTagsResponse/placementTags: placement_tags +/dfareporting:v2.7/PlacementsGenerateTagsResponse/placementTags/placement_tag: placement_tag +/dfareporting:v2.7/PlacementsListResponse: placements_list_response +/dfareporting:v2.7/PlacementsListResponse/kind: kind +/dfareporting:v2.7/PlacementsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementsListResponse/placements: placements +/dfareporting:v2.7/PlacementsListResponse/placements/placement: placement +/dfareporting:v2.7/PlatformType: platform_type +/dfareporting:v2.7/PlatformType/id: id +/dfareporting:v2.7/PlatformType/kind: kind +/dfareporting:v2.7/PlatformType/name: name +/dfareporting:v2.7/PlatformTypesListResponse: platform_types_list_response +/dfareporting:v2.7/PlatformTypesListResponse/kind: kind +/dfareporting:v2.7/PlatformTypesListResponse/platformTypes: platform_types +/dfareporting:v2.7/PlatformTypesListResponse/platformTypes/platform_type: platform_type +/dfareporting:v2.7/PopupWindowProperties: popup_window_properties +/dfareporting:v2.7/PopupWindowProperties/dimension: dimension +/dfareporting:v2.7/PopupWindowProperties/offset: offset +/dfareporting:v2.7/PopupWindowProperties/positionType: position_type +/dfareporting:v2.7/PopupWindowProperties/showAddressBar: show_address_bar +/dfareporting:v2.7/PopupWindowProperties/showMenuBar: show_menu_bar +/dfareporting:v2.7/PopupWindowProperties/showScrollBar: show_scroll_bar +/dfareporting:v2.7/PopupWindowProperties/showStatusBar: show_status_bar +/dfareporting:v2.7/PopupWindowProperties/showToolBar: show_tool_bar +/dfareporting:v2.7/PopupWindowProperties/title: title +/dfareporting:v2.7/PostalCode: postal_code +/dfareporting:v2.7/PostalCode/code: code +/dfareporting:v2.7/PostalCode/countryCode: country_code +/dfareporting:v2.7/PostalCode/countryDartId: country_dart_id +/dfareporting:v2.7/PostalCode/id: id +/dfareporting:v2.7/PostalCode/kind: kind +/dfareporting:v2.7/PostalCodesListResponse: postal_codes_list_response +/dfareporting:v2.7/PostalCodesListResponse/kind: kind +/dfareporting:v2.7/PostalCodesListResponse/postalCodes: postal_codes +/dfareporting:v2.7/PostalCodesListResponse/postalCodes/postal_code: postal_code +/dfareporting:v2.7/Pricing: pricing +/dfareporting:v2.7/Pricing/capCostType: cap_cost_type +/dfareporting:v2.7/Pricing/endDate: end_date +/dfareporting:v2.7/Pricing/flights: flights +/dfareporting:v2.7/Pricing/flights/flight: flight +/dfareporting:v2.7/Pricing/groupType: group_type +/dfareporting:v2.7/Pricing/pricingType: pricing_type +/dfareporting:v2.7/Pricing/startDate: start_date +/dfareporting:v2.7/PricingSchedule: pricing_schedule +/dfareporting:v2.7/PricingSchedule/capCostOption: cap_cost_option +/dfareporting:v2.7/PricingSchedule/disregardOverdelivery: disregard_overdelivery +/dfareporting:v2.7/PricingSchedule/endDate: end_date +/dfareporting:v2.7/PricingSchedule/flighted: flighted +/dfareporting:v2.7/PricingSchedule/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/PricingSchedule/pricingPeriods: pricing_periods +/dfareporting:v2.7/PricingSchedule/pricingPeriods/pricing_period: pricing_period +/dfareporting:v2.7/PricingSchedule/pricingType: pricing_type +/dfareporting:v2.7/PricingSchedule/startDate: start_date +/dfareporting:v2.7/PricingSchedule/testingStartDate: testing_start_date +/dfareporting:v2.7/PricingSchedulePricingPeriod: pricing_schedule_pricing_period +/dfareporting:v2.7/PricingSchedulePricingPeriod/endDate: end_date +/dfareporting:v2.7/PricingSchedulePricingPeriod/pricingComment: pricing_comment +/dfareporting:v2.7/PricingSchedulePricingPeriod/rateOrCostNanos: rate_or_cost_nanos +/dfareporting:v2.7/PricingSchedulePricingPeriod/startDate: start_date +/dfareporting:v2.7/PricingSchedulePricingPeriod/units: units +/dfareporting:v2.7/Project: project +/dfareporting:v2.7/Project/accountId: account_id +/dfareporting:v2.7/Project/advertiserId: advertiser_id +/dfareporting:v2.7/Project/audienceAgeGroup: audience_age_group +/dfareporting:v2.7/Project/audienceGender: audience_gender +/dfareporting:v2.7/Project/budget: budget +/dfareporting:v2.7/Project/clientBillingCode: client_billing_code +/dfareporting:v2.7/Project/clientName: client_name +/dfareporting:v2.7/Project/endDate: end_date +/dfareporting:v2.7/Project/id: id +/dfareporting:v2.7/Project/kind: kind +/dfareporting:v2.7/Project/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Project/name: name +/dfareporting:v2.7/Project/overview: overview +/dfareporting:v2.7/Project/startDate: start_date +/dfareporting:v2.7/Project/subaccountId: subaccount_id +/dfareporting:v2.7/Project/targetClicks: target_clicks +/dfareporting:v2.7/Project/targetConversions: target_conversions +/dfareporting:v2.7/Project/targetCpaNanos: target_cpa_nanos +/dfareporting:v2.7/Project/targetCpcNanos: target_cpc_nanos +/dfareporting:v2.7/Project/targetCpmActiveViewNanos: target_cpm_active_view_nanos +/dfareporting:v2.7/Project/targetCpmNanos: target_cpm_nanos +/dfareporting:v2.7/Project/targetImpressions: target_impressions +/dfareporting:v2.7/ProjectsListResponse: projects_list_response +/dfareporting:v2.7/ProjectsListResponse/kind: kind +/dfareporting:v2.7/ProjectsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ProjectsListResponse/projects: projects +/dfareporting:v2.7/ProjectsListResponse/projects/project: project +/dfareporting:v2.7/ReachReportCompatibleFields: reach_report_compatible_fields +/dfareporting:v2.7/ReachReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/ReachReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/ReachReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/ReachReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/ReachReportCompatibleFields/kind: kind +/dfareporting:v2.7/ReachReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/ReachReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/ReachReportCompatibleFields/pivotedActivityMetrics: pivoted_activity_metrics +/dfareporting:v2.7/ReachReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric: pivoted_activity_metric +/dfareporting:v2.7/ReachReportCompatibleFields/reachByFrequencyMetrics: reach_by_frequency_metrics +/dfareporting:v2.7/ReachReportCompatibleFields/reachByFrequencyMetrics/reach_by_frequency_metric: reach_by_frequency_metric +/dfareporting:v2.7/Recipient: recipient +/dfareporting:v2.7/Recipient/deliveryType: delivery_type +/dfareporting:v2.7/Recipient/email: email +/dfareporting:v2.7/Recipient/kind: kind +/dfareporting:v2.7/Region: region +/dfareporting:v2.7/Region/countryCode: country_code +/dfareporting:v2.7/Region/countryDartId: country_dart_id +/dfareporting:v2.7/Region/dartId: dart_id +/dfareporting:v2.7/Region/kind: kind +/dfareporting:v2.7/Region/name: name +/dfareporting:v2.7/Region/regionCode: region_code +/dfareporting:v2.7/RegionsListResponse: regions_list_response +/dfareporting:v2.7/RegionsListResponse/kind: kind +/dfareporting:v2.7/RegionsListResponse/regions: regions +/dfareporting:v2.7/RegionsListResponse/regions/region: region +/dfareporting:v2.7/RemarketingList: remarketing_list +/dfareporting:v2.7/RemarketingList/accountId: account_id +/dfareporting:v2.7/RemarketingList/active: active +/dfareporting:v2.7/RemarketingList/advertiserId: advertiser_id +/dfareporting:v2.7/RemarketingList/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/RemarketingList/description: description +/dfareporting:v2.7/RemarketingList/id: id +/dfareporting:v2.7/RemarketingList/kind: kind +/dfareporting:v2.7/RemarketingList/lifeSpan: life_span +/dfareporting:v2.7/RemarketingList/listPopulationRule: list_population_rule +/dfareporting:v2.7/RemarketingList/listSize: list_size +/dfareporting:v2.7/RemarketingList/listSource: list_source +/dfareporting:v2.7/RemarketingList/name: name +/dfareporting:v2.7/RemarketingList/subaccountId: subaccount_id +/dfareporting:v2.7/RemarketingListShare: remarketing_list_share +/dfareporting:v2.7/RemarketingListShare/kind: kind +/dfareporting:v2.7/RemarketingListShare/remarketingListId: remarketing_list_id +/dfareporting:v2.7/RemarketingListShare/sharedAccountIds: shared_account_ids +/dfareporting:v2.7/RemarketingListShare/sharedAccountIds/shared_account_id: shared_account_id +/dfareporting:v2.7/RemarketingListShare/sharedAdvertiserIds: shared_advertiser_ids +/dfareporting:v2.7/RemarketingListShare/sharedAdvertiserIds/shared_advertiser_id: shared_advertiser_id +/dfareporting:v2.7/RemarketingListsListResponse: remarketing_lists_list_response +/dfareporting:v2.7/RemarketingListsListResponse/kind: kind +/dfareporting:v2.7/RemarketingListsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/RemarketingListsListResponse/remarketingLists: remarketing_lists +/dfareporting:v2.7/RemarketingListsListResponse/remarketingLists/remarketing_list: remarketing_list +/dfareporting:v2.7/Report: report +/dfareporting:v2.7/Report/accountId: account_id +/dfareporting:v2.7/Report/criteria: criteria +/dfareporting:v2.7/Report/criteria/activities: activities +/dfareporting:v2.7/Report/criteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/criteria/dateRange: date_range +/dfareporting:v2.7/Report/criteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/criteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/criteria/dimensions: dimensions +/dfareporting:v2.7/Report/criteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/criteria/metricNames: metric_names +/dfareporting:v2.7/Report/criteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria: cross_dimension_reach_criteria +/dfareporting:v2.7/Report/crossDimensionReachCriteria/breakdown: breakdown +/dfareporting:v2.7/Report/crossDimensionReachCriteria/breakdown/breakdown: breakdown +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dateRange: date_range +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimension: dimension +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/crossDimensionReachCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/crossDimensionReachCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria/overlapMetricNames: overlap_metric_names +/dfareporting:v2.7/Report/crossDimensionReachCriteria/overlapMetricNames/overlap_metric_name: overlap_metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria/pivoted: pivoted +/dfareporting:v2.7/Report/delivery: delivery +/dfareporting:v2.7/Report/delivery/emailOwner: email_owner +/dfareporting:v2.7/Report/delivery/emailOwnerDeliveryType: email_owner_delivery_type +/dfareporting:v2.7/Report/delivery/message: message +/dfareporting:v2.7/Report/delivery/recipients: recipients +/dfareporting:v2.7/Report/delivery/recipients/recipient: recipient +/dfareporting:v2.7/Report/etag: etag +/dfareporting:v2.7/Report/fileName: file_name +/dfareporting:v2.7/Report/floodlightCriteria: floodlight_criteria +/dfareporting:v2.7/Report/floodlightCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/floodlightCriteria/customRichMediaEvents/custom_rich_media_event: custom_rich_media_event +/dfareporting:v2.7/Report/floodlightCriteria/dateRange: date_range +/dfareporting:v2.7/Report/floodlightCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/floodlightCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/floodlightCriteria/dimensions: dimensions +/dfareporting:v2.7/Report/floodlightCriteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/floodlightCriteria/floodlightConfigId: floodlight_config_id +/dfareporting:v2.7/Report/floodlightCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/floodlightCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties: report_properties +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeAttributedIPConversions: include_attributed_ip_conversions +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeUnattributedCookieConversions: include_unattributed_cookie_conversions +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeUnattributedIPConversions: include_unattributed_ip_conversions +/dfareporting:v2.7/Report/format: format +/dfareporting:v2.7/Report/id: id +/dfareporting:v2.7/Report/kind: kind +/dfareporting:v2.7/Report/lastModifiedTime: last_modified_time +/dfareporting:v2.7/Report/name: name +/dfareporting:v2.7/Report/ownerProfileId: owner_profile_id +/dfareporting:v2.7/Report/pathToConversionCriteria: path_to_conversion_criteria +/dfareporting:v2.7/Report/pathToConversionCriteria/activityFilters: activity_filters +/dfareporting:v2.7/Report/pathToConversionCriteria/activityFilters/activity_filter: activity_filter +/dfareporting:v2.7/Report/pathToConversionCriteria/conversionDimensions: conversion_dimensions +/dfareporting:v2.7/Report/pathToConversionCriteria/conversionDimensions/conversion_dimension: conversion_dimension +/dfareporting:v2.7/Report/pathToConversionCriteria/customFloodlightVariables: custom_floodlight_variables +/dfareporting:v2.7/Report/pathToConversionCriteria/customFloodlightVariables/custom_floodlight_variable: custom_floodlight_variable +/dfareporting:v2.7/Report/pathToConversionCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/pathToConversionCriteria/customRichMediaEvents/custom_rich_media_event: custom_rich_media_event +/dfareporting:v2.7/Report/pathToConversionCriteria/dateRange: date_range +/dfareporting:v2.7/Report/pathToConversionCriteria/floodlightConfigId: floodlight_config_id +/dfareporting:v2.7/Report/pathToConversionCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/pathToConversionCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/pathToConversionCriteria/perInteractionDimensions: per_interaction_dimensions +/dfareporting:v2.7/Report/pathToConversionCriteria/perInteractionDimensions/per_interaction_dimension: per_interaction_dimension +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties: report_properties +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/clicksLookbackWindow: clicks_lookback_window +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/impressionsLookbackWindow: impressions_lookback_window +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeAttributedIPConversions: include_attributed_ip_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeUnattributedCookieConversions: include_unattributed_cookie_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeUnattributedIPConversions: include_unattributed_ip_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumClickInteractions: maximum_click_interactions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumImpressionInteractions: maximum_impression_interactions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumInteractionGap: maximum_interaction_gap +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/pivotOnInteractionPath: pivot_on_interaction_path +/dfareporting:v2.7/Report/reachCriteria: reach_criteria +/dfareporting:v2.7/Report/reachCriteria/activities: activities +/dfareporting:v2.7/Report/reachCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/reachCriteria/dateRange: date_range +/dfareporting:v2.7/Report/reachCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/reachCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/reachCriteria/dimensions: dimensions +/dfareporting:v2.7/Report/reachCriteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/reachCriteria/enableAllDimensionCombinations: enable_all_dimension_combinations +/dfareporting:v2.7/Report/reachCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/reachCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/reachCriteria/reachByFrequencyMetricNames: reach_by_frequency_metric_names +/dfareporting:v2.7/Report/reachCriteria/reachByFrequencyMetricNames/reach_by_frequency_metric_name: reach_by_frequency_metric_name +/dfareporting:v2.7/Report/schedule: schedule +/dfareporting:v2.7/Report/schedule/active: active +/dfareporting:v2.7/Report/schedule/every: every +/dfareporting:v2.7/Report/schedule/expirationDate: expiration_date +/dfareporting:v2.7/Report/schedule/repeats: repeats +/dfareporting:v2.7/Report/schedule/repeatsOnWeekDays: repeats_on_week_days +/dfareporting:v2.7/Report/schedule/repeatsOnWeekDays/repeats_on_week_day: repeats_on_week_day +/dfareporting:v2.7/Report/schedule/runsOnDayOfMonth: runs_on_day_of_month +/dfareporting:v2.7/Report/schedule/startDate: start_date +/dfareporting:v2.7/Report/subAccountId: sub_account_id +/dfareporting:v2.7/Report/type: type +/dfareporting:v2.7/ReportCompatibleFields: report_compatible_fields +/dfareporting:v2.7/ReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/ReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/ReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/ReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/ReportCompatibleFields/kind: kind +/dfareporting:v2.7/ReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/ReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/ReportCompatibleFields/pivotedActivityMetrics: pivoted_activity_metrics +/dfareporting:v2.7/ReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric: pivoted_activity_metric +/dfareporting:v2.7/ReportList: report_list +/dfareporting:v2.7/ReportList/etag: etag +/dfareporting:v2.7/ReportList/items: items +/dfareporting:v2.7/ReportList/items/item: item +/dfareporting:v2.7/ReportList/kind: kind +/dfareporting:v2.7/ReportList/nextPageToken: next_page_token +/dfareporting:v2.7/ReportsConfiguration: reports_configuration +/dfareporting:v2.7/ReportsConfiguration/exposureToConversionEnabled: exposure_to_conversion_enabled +/dfareporting:v2.7/ReportsConfiguration/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/ReportsConfiguration/reportGenerationTimeZoneId: report_generation_time_zone_id +/dfareporting:v2.7/RichMediaExitOverride: rich_media_exit_override +/dfareporting:v2.7/RichMediaExitOverride/clickThroughUrl: click_through_url +/dfareporting:v2.7/RichMediaExitOverride/enabled: enabled +/dfareporting:v2.7/RichMediaExitOverride/exitId: exit_id +/dfareporting:v2.7/Rule: rule +/dfareporting:v2.7/Rule/assetId: asset_id +/dfareporting:v2.7/Rule/name: name +/dfareporting:v2.7/Rule/targetingTemplateId: targeting_template_id +/dfareporting:v2.7/Site: site +/dfareporting:v2.7/Site/accountId: account_id +/dfareporting:v2.7/Site/approved: approved +/dfareporting:v2.7/Site/directorySiteId: directory_site_id +/dfareporting:v2.7/Site/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/Site/id: id +/dfareporting:v2.7/Site/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Site/keyName: key_name +/dfareporting:v2.7/Site/kind: kind +/dfareporting:v2.7/Site/name: name +/dfareporting:v2.7/Site/siteContacts: site_contacts +/dfareporting:v2.7/Site/siteContacts/site_contact: site_contact +/dfareporting:v2.7/Site/siteSettings: site_settings +/dfareporting:v2.7/Site/subaccountId: subaccount_id +/dfareporting:v2.7/SiteContact: site_contact +/dfareporting:v2.7/SiteContact/address: address +/dfareporting:v2.7/SiteContact/contactType: contact_type +/dfareporting:v2.7/SiteContact/email: email +/dfareporting:v2.7/SiteContact/firstName: first_name +/dfareporting:v2.7/SiteContact/id: id +/dfareporting:v2.7/SiteContact/lastName: last_name +/dfareporting:v2.7/SiteContact/phone: phone +/dfareporting:v2.7/SiteContact/title: title +/dfareporting:v2.7/SiteSettings: site_settings +/dfareporting:v2.7/SiteSettings/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/SiteSettings/creativeSettings: creative_settings +/dfareporting:v2.7/SiteSettings/disableBrandSafeAds: disable_brand_safe_ads +/dfareporting:v2.7/SiteSettings/disableNewCookie: disable_new_cookie +/dfareporting:v2.7/SiteSettings/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/SiteSettings/tagSetting: tag_setting +/dfareporting:v2.7/SiteSettings/videoActiveViewOptOutTemplate: video_active_view_opt_out_template +/dfareporting:v2.7/SiteSettings/vpaidAdapterChoiceTemplate: vpaid_adapter_choice_template +/dfareporting:v2.7/SitesListResponse: sites_list_response +/dfareporting:v2.7/SitesListResponse/kind: kind +/dfareporting:v2.7/SitesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/SitesListResponse/sites: sites +/dfareporting:v2.7/SitesListResponse/sites/site: site +/dfareporting:v2.7/Size: size +/dfareporting:v2.7/Size/height: height +/dfareporting:v2.7/Size/iab: iab +/dfareporting:v2.7/Size/id: id +/dfareporting:v2.7/Size/kind: kind +/dfareporting:v2.7/Size/width: width +/dfareporting:v2.7/SizesListResponse: sizes_list_response +/dfareporting:v2.7/SizesListResponse/kind: kind +/dfareporting:v2.7/SizesListResponse/sizes: sizes +/dfareporting:v2.7/SizesListResponse/sizes/size: size +/dfareporting:v2.7/SkippableSetting: skippable_setting +/dfareporting:v2.7/SkippableSetting/kind: kind +/dfareporting:v2.7/SkippableSetting/progressOffset: progress_offset +/dfareporting:v2.7/SkippableSetting/skipOffset: skip_offset +/dfareporting:v2.7/SkippableSetting/skippable: skippable +/dfareporting:v2.7/SortedDimension: sorted_dimension +/dfareporting:v2.7/SortedDimension/kind: kind +/dfareporting:v2.7/SortedDimension/name: name +/dfareporting:v2.7/SortedDimension/sortOrder: sort_order +/dfareporting:v2.7/Subaccount: subaccount +/dfareporting:v2.7/Subaccount/accountId: account_id +/dfareporting:v2.7/Subaccount/availablePermissionIds: available_permission_ids +/dfareporting:v2.7/Subaccount/availablePermissionIds/available_permission_id: available_permission_id +/dfareporting:v2.7/Subaccount/id: id +/dfareporting:v2.7/Subaccount/kind: kind +/dfareporting:v2.7/Subaccount/name: name +/dfareporting:v2.7/SubaccountsListResponse: subaccounts_list_response +/dfareporting:v2.7/SubaccountsListResponse/kind: kind +/dfareporting:v2.7/SubaccountsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/SubaccountsListResponse/subaccounts: subaccounts +/dfareporting:v2.7/SubaccountsListResponse/subaccounts/subaccount: subaccount +/dfareporting:v2.7/TagData: tag_data +/dfareporting:v2.7/TagData/adId: ad_id +/dfareporting:v2.7/TagData/clickTag: click_tag +/dfareporting:v2.7/TagData/creativeId: creative_id +/dfareporting:v2.7/TagData/format: format +/dfareporting:v2.7/TagData/impressionTag: impression_tag +/dfareporting:v2.7/TagSetting: tag_setting +/dfareporting:v2.7/TagSetting/additionalKeyValues: additional_key_values +/dfareporting:v2.7/TagSetting/includeClickThroughUrls: include_click_through_urls +/dfareporting:v2.7/TagSetting/includeClickTracking: include_click_tracking +/dfareporting:v2.7/TagSetting/keywordOption: keyword_option +/dfareporting:v2.7/TagSettings: tag_settings +/dfareporting:v2.7/TagSettings/dynamicTagEnabled: dynamic_tag_enabled +/dfareporting:v2.7/TagSettings/imageTagEnabled: image_tag_enabled +/dfareporting:v2.7/TargetWindow: target_window +/dfareporting:v2.7/TargetWindow/customHtml: custom_html +/dfareporting:v2.7/TargetWindow/targetWindowOption: target_window_option +/dfareporting:v2.7/TargetableRemarketingList: targetable_remarketing_list +/dfareporting:v2.7/TargetableRemarketingList/accountId: account_id +/dfareporting:v2.7/TargetableRemarketingList/active: active +/dfareporting:v2.7/TargetableRemarketingList/advertiserId: advertiser_id +/dfareporting:v2.7/TargetableRemarketingList/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/TargetableRemarketingList/description: description +/dfareporting:v2.7/TargetableRemarketingList/id: id +/dfareporting:v2.7/TargetableRemarketingList/kind: kind +/dfareporting:v2.7/TargetableRemarketingList/lifeSpan: life_span +/dfareporting:v2.7/TargetableRemarketingList/listSize: list_size +/dfareporting:v2.7/TargetableRemarketingList/listSource: list_source +/dfareporting:v2.7/TargetableRemarketingList/name: name +/dfareporting:v2.7/TargetableRemarketingList/subaccountId: subaccount_id +/dfareporting:v2.7/TargetableRemarketingListsListResponse: targetable_remarketing_lists_list_response +/dfareporting:v2.7/TargetableRemarketingListsListResponse/kind: kind +/dfareporting:v2.7/TargetableRemarketingListsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/TargetableRemarketingListsListResponse/targetableRemarketingLists: targetable_remarketing_lists +/dfareporting:v2.7/TargetableRemarketingListsListResponse/targetableRemarketingLists/targetable_remarketing_list: targetable_remarketing_list +/dfareporting:v2.7/TargetingTemplate: targeting_template +/dfareporting:v2.7/TargetingTemplate/accountId: account_id +/dfareporting:v2.7/TargetingTemplate/advertiserId: advertiser_id +/dfareporting:v2.7/TargetingTemplate/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/TargetingTemplate/dayPartTargeting: day_part_targeting +/dfareporting:v2.7/TargetingTemplate/geoTargeting: geo_targeting +/dfareporting:v2.7/TargetingTemplate/id: id +/dfareporting:v2.7/TargetingTemplate/keyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/TargetingTemplate/kind: kind +/dfareporting:v2.7/TargetingTemplate/languageTargeting: language_targeting +/dfareporting:v2.7/TargetingTemplate/listTargetingExpression: list_targeting_expression +/dfareporting:v2.7/TargetingTemplate/name: name +/dfareporting:v2.7/TargetingTemplate/subaccountId: subaccount_id +/dfareporting:v2.7/TargetingTemplate/technologyTargeting: technology_targeting +/dfareporting:v2.7/TargetingTemplatesListResponse: targeting_templates_list_response +/dfareporting:v2.7/TargetingTemplatesListResponse/kind: kind +/dfareporting:v2.7/TargetingTemplatesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/TargetingTemplatesListResponse/targetingTemplates: targeting_templates +/dfareporting:v2.7/TargetingTemplatesListResponse/targetingTemplates/targeting_template: targeting_template +/dfareporting:v2.7/TechnologyTargeting: technology_targeting +/dfareporting:v2.7/TechnologyTargeting/browsers: browsers +/dfareporting:v2.7/TechnologyTargeting/browsers/browser: browser +/dfareporting:v2.7/TechnologyTargeting/connectionTypes: connection_types +/dfareporting:v2.7/TechnologyTargeting/connectionTypes/connection_type: connection_type +/dfareporting:v2.7/TechnologyTargeting/mobileCarriers: mobile_carriers +/dfareporting:v2.7/TechnologyTargeting/mobileCarriers/mobile_carrier: mobile_carrier +/dfareporting:v2.7/TechnologyTargeting/operatingSystemVersions: operating_system_versions +/dfareporting:v2.7/TechnologyTargeting/operatingSystemVersions/operating_system_version: operating_system_version +/dfareporting:v2.7/TechnologyTargeting/operatingSystems: operating_systems +/dfareporting:v2.7/TechnologyTargeting/operatingSystems/operating_system: operating_system +/dfareporting:v2.7/TechnologyTargeting/platformTypes: platform_types +/dfareporting:v2.7/TechnologyTargeting/platformTypes/platform_type: platform_type +/dfareporting:v2.7/ThirdPartyAuthenticationToken: third_party_authentication_token +/dfareporting:v2.7/ThirdPartyAuthenticationToken/name: name +/dfareporting:v2.7/ThirdPartyAuthenticationToken/value: value +/dfareporting:v2.7/ThirdPartyTrackingUrl: third_party_tracking_url +/dfareporting:v2.7/ThirdPartyTrackingUrl/thirdPartyUrlType: third_party_url_type +/dfareporting:v2.7/ThirdPartyTrackingUrl/url: url +/dfareporting:v2.7/TranscodeSetting: transcode_setting +/dfareporting:v2.7/TranscodeSetting/enabledVideoFormats: enabled_video_formats +/dfareporting:v2.7/TranscodeSetting/enabledVideoFormats/enabled_video_format: enabled_video_format +/dfareporting:v2.7/TranscodeSetting/kind: kind +/dfareporting:v2.7/UserDefinedVariableConfiguration: user_defined_variable_configuration +/dfareporting:v2.7/UserDefinedVariableConfiguration/dataType: data_type +/dfareporting:v2.7/UserDefinedVariableConfiguration/reportName: report_name +/dfareporting:v2.7/UserDefinedVariableConfiguration/variableType: variable_type +/dfareporting:v2.7/UserProfile: user_profile +/dfareporting:v2.7/UserProfile/accountId: account_id +/dfareporting:v2.7/UserProfile/accountName: account_name +/dfareporting:v2.7/UserProfile/etag: etag +/dfareporting:v2.7/UserProfile/kind: kind +/dfareporting:v2.7/UserProfile/profileId: profile_id +/dfareporting:v2.7/UserProfile/subAccountId: sub_account_id +/dfareporting:v2.7/UserProfile/subAccountName: sub_account_name +/dfareporting:v2.7/UserProfile/userName: user_name +/dfareporting:v2.7/UserProfileList: user_profile_list +/dfareporting:v2.7/UserProfileList/etag: etag +/dfareporting:v2.7/UserProfileList/items: items +/dfareporting:v2.7/UserProfileList/items/item: item +/dfareporting:v2.7/UserProfileList/kind: kind +/dfareporting:v2.7/UserRole: user_role +/dfareporting:v2.7/UserRole/accountId: account_id +/dfareporting:v2.7/UserRole/defaultUserRole: default_user_role +/dfareporting:v2.7/UserRole/id: id +/dfareporting:v2.7/UserRole/kind: kind +/dfareporting:v2.7/UserRole/name: name +/dfareporting:v2.7/UserRole/parentUserRoleId: parent_user_role_id +/dfareporting:v2.7/UserRole/permissions: permissions +/dfareporting:v2.7/UserRole/permissions/permission: permission +/dfareporting:v2.7/UserRole/subaccountId: subaccount_id +/dfareporting:v2.7/UserRolePermission: user_role_permission +/dfareporting:v2.7/UserRolePermission/availability: availability +/dfareporting:v2.7/UserRolePermission/id: id +/dfareporting:v2.7/UserRolePermission/kind: kind +/dfareporting:v2.7/UserRolePermission/name: name +/dfareporting:v2.7/UserRolePermission/permissionGroupId: permission_group_id +/dfareporting:v2.7/UserRolePermissionGroup: user_role_permission_group +/dfareporting:v2.7/UserRolePermissionGroup/id: id +/dfareporting:v2.7/UserRolePermissionGroup/kind: kind +/dfareporting:v2.7/UserRolePermissionGroup/name: name +/dfareporting:v2.7/UserRolePermissionGroupsListResponse: user_role_permission_groups_list_response +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/kind: kind +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/userRolePermissionGroups: user_role_permission_groups +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/userRolePermissionGroups/user_role_permission_group: user_role_permission_group +/dfareporting:v2.7/UserRolePermissionsListResponse: user_role_permissions_list_response +/dfareporting:v2.7/UserRolePermissionsListResponse/kind: kind +/dfareporting:v2.7/UserRolePermissionsListResponse/userRolePermissions: user_role_permissions +/dfareporting:v2.7/UserRolePermissionsListResponse/userRolePermissions/user_role_permission: user_role_permission +/dfareporting:v2.7/UserRolesListResponse: user_roles_list_response +/dfareporting:v2.7/UserRolesListResponse/kind: kind +/dfareporting:v2.7/UserRolesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/UserRolesListResponse/userRoles: user_roles +/dfareporting:v2.7/UserRolesListResponse/userRoles/user_role: user_role +/dfareporting:v2.7/VideoFormat: video_format +/dfareporting:v2.7/VideoFormat/fileType: file_type +/dfareporting:v2.7/VideoFormat/id: id +/dfareporting:v2.7/VideoFormat/kind: kind +/dfareporting:v2.7/VideoFormat/resolution: resolution +/dfareporting:v2.7/VideoFormat/targetBitRate: target_bit_rate +/dfareporting:v2.7/VideoFormatsListResponse: video_formats_list_response +/dfareporting:v2.7/VideoFormatsListResponse/kind: kind +/dfareporting:v2.7/VideoFormatsListResponse/videoFormats: video_formats +/dfareporting:v2.7/VideoFormatsListResponse/videoFormats/video_format: video_format +/dfareporting:v2.7/VideoOffset: video_offset +/dfareporting:v2.7/VideoOffset/offsetPercentage: offset_percentage +/dfareporting:v2.7/VideoOffset/offsetSeconds: offset_seconds +/dfareporting:v2.7/VideoSettings: video_settings +/dfareporting:v2.7/VideoSettings/companionSettings: companion_settings +/dfareporting:v2.7/VideoSettings/kind: kind +/dfareporting:v2.7/VideoSettings/skippableSettings: skippable_settings +/dfareporting:v2.7/VideoSettings/transcodeSettings: transcode_settings diff --git a/api_names_out.yaml b/api_names_out.yaml index b0270dc1c..d4dc3cda1 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -33378,3 +33378,2559 @@ /dns:v2beta1/ResourceRecordSetsListResponse/rrsets/rrset: rrset /dns:v2beta1/ResponseHeader: response_header /dns:v2beta1/ResponseHeader/operationId: operation_id +/dfareporting:v2.7/fields: fields +/dfareporting:v2.7/key: key +/dfareporting:v2.7/quotaUser: quota_user +/dfareporting:v2.7/userIp: user_ip +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get: get_account_active_ad_summary +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountActiveAdSummaries.get/summaryAccountId: summary_account_id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get: get_account_permission_group +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get/id: id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissionGroups.list: list_account_permission_groups +/dfareporting:v2.7/dfareporting.accountPermissionGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissions.get: get_account_permission +/dfareporting:v2.7/dfareporting.accountPermissions.get/id: id +/dfareporting:v2.7/dfareporting.accountPermissions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountPermissions.list: list_account_permissions +/dfareporting:v2.7/dfareporting.accountPermissions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.get: get_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.get/id: id +/dfareporting:v2.7/dfareporting.accountUserProfiles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.insert: insert_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list: list_account_user_profiles +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/active: active +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/ids: ids +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/searchString: search_string +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.list/userRoleId: user_role_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch: patch_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch/id: id +/dfareporting:v2.7/dfareporting.accountUserProfiles.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.accountUserProfiles.update: update_account_user_profile +/dfareporting:v2.7/dfareporting.accountUserProfiles.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.get: get_account +/dfareporting:v2.7/dfareporting.accounts.get/id: id +/dfareporting:v2.7/dfareporting.accounts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.list: list_accounts +/dfareporting:v2.7/dfareporting.accounts.list/active: active +/dfareporting:v2.7/dfareporting.accounts.list/ids: ids +/dfareporting:v2.7/dfareporting.accounts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.accounts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.accounts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.accounts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.accounts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.accounts.patch: patch_account +/dfareporting:v2.7/dfareporting.accounts.patch/id: id +/dfareporting:v2.7/dfareporting.accounts.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.accounts.update: update_account +/dfareporting:v2.7/dfareporting.accounts.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.get: get_ad +/dfareporting:v2.7/dfareporting.ads.get/id: id +/dfareporting:v2.7/dfareporting.ads.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.insert: insert_ad +/dfareporting:v2.7/dfareporting.ads.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.list: list_ads +/dfareporting:v2.7/dfareporting.ads.list/active: active +/dfareporting:v2.7/dfareporting.ads.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.ads.list/archived: archived +/dfareporting:v2.7/dfareporting.ads.list/audienceSegmentIds: audience_segment_ids +/dfareporting:v2.7/dfareporting.ads.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.ads.list/compatibility: compatibility +/dfareporting:v2.7/dfareporting.ads.list/creativeIds: creative_ids +/dfareporting:v2.7/dfareporting.ads.list/creativeOptimizationConfigurationIds: creative_optimization_configuration_ids +/dfareporting:v2.7/dfareporting.ads.list/dynamicClickTracker: dynamic_click_tracker +/dfareporting:v2.7/dfareporting.ads.list/ids: ids +/dfareporting:v2.7/dfareporting.ads.list/landingPageIds: landing_page_ids +/dfareporting:v2.7/dfareporting.ads.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.ads.list/overriddenEventTagId: overridden_event_tag_id +/dfareporting:v2.7/dfareporting.ads.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.ads.list/placementIds: placement_ids +/dfareporting:v2.7/dfareporting.ads.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.list/remarketingListIds: remarketing_list_ids +/dfareporting:v2.7/dfareporting.ads.list/searchString: search_string +/dfareporting:v2.7/dfareporting.ads.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.ads.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.ads.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.ads.list/sslCompliant: ssl_compliant +/dfareporting:v2.7/dfareporting.ads.list/sslRequired: ssl_required +/dfareporting:v2.7/dfareporting.ads.list/type: type +/dfareporting:v2.7/dfareporting.ads.patch: patch_ad +/dfareporting:v2.7/dfareporting.ads.patch/id: id +/dfareporting:v2.7/dfareporting.ads.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.ads.update: update_ad +/dfareporting:v2.7/dfareporting.ads.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.delete: delete_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.delete/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.get: get_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.get/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.insert: insert_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.list: list_advertiser_groups +/dfareporting:v2.7/dfareporting.advertiserGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.advertiserGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.advertiserGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.advertiserGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.advertiserGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.advertiserGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.advertiserGroups.patch: patch_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.patch/id: id +/dfareporting:v2.7/dfareporting.advertiserGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertiserGroups.update: update_advertiser_group +/dfareporting:v2.7/dfareporting.advertiserGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.get: get_advertiser +/dfareporting:v2.7/dfareporting.advertisers.get/id: id +/dfareporting:v2.7/dfareporting.advertisers.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.insert: insert_advertiser +/dfareporting:v2.7/dfareporting.advertisers.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.list: list_advertisers +/dfareporting:v2.7/dfareporting.advertisers.list/advertiserGroupIds: advertiser_group_ids +/dfareporting:v2.7/dfareporting.advertisers.list/floodlightConfigurationIds: floodlight_configuration_ids +/dfareporting:v2.7/dfareporting.advertisers.list/ids: ids +/dfareporting:v2.7/dfareporting.advertisers.list/includeAdvertisersWithoutGroupsOnly: include_advertisers_without_groups_only +/dfareporting:v2.7/dfareporting.advertisers.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.advertisers.list/onlyParent: only_parent +/dfareporting:v2.7/dfareporting.advertisers.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.advertisers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.list/searchString: search_string +/dfareporting:v2.7/dfareporting.advertisers.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.advertisers.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.advertisers.list/status: status +/dfareporting:v2.7/dfareporting.advertisers.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.advertisers.patch: patch_advertiser +/dfareporting:v2.7/dfareporting.advertisers.patch/id: id +/dfareporting:v2.7/dfareporting.advertisers.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.advertisers.update: update_advertiser +/dfareporting:v2.7/dfareporting.advertisers.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.browsers.list: list_browsers +/dfareporting:v2.7/dfareporting.browsers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert: insert_campaign_creative_association +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list: list_campaign_creative_associations +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaignCreativeAssociations.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.campaigns.get: get_campaign +/dfareporting:v2.7/dfareporting.campaigns.get/id: id +/dfareporting:v2.7/dfareporting.campaigns.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.insert: insert_campaign +/dfareporting:v2.7/dfareporting.campaigns.insert/defaultLandingPageName: default_landing_page_name +/dfareporting:v2.7/dfareporting.campaigns.insert/defaultLandingPageUrl: default_landing_page_url +/dfareporting:v2.7/dfareporting.campaigns.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.list: list_campaigns +/dfareporting:v2.7/dfareporting.campaigns.list/advertiserGroupIds: advertiser_group_ids +/dfareporting:v2.7/dfareporting.campaigns.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.campaigns.list/archived: archived +/dfareporting:v2.7/dfareporting.campaigns.list/atLeastOneOptimizationActivity: at_least_one_optimization_activity +/dfareporting:v2.7/dfareporting.campaigns.list/excludedIds: excluded_ids +/dfareporting:v2.7/dfareporting.campaigns.list/ids: ids +/dfareporting:v2.7/dfareporting.campaigns.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.campaigns.list/overriddenEventTagId: overridden_event_tag_id +/dfareporting:v2.7/dfareporting.campaigns.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.campaigns.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.list/searchString: search_string +/dfareporting:v2.7/dfareporting.campaigns.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.campaigns.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.campaigns.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.campaigns.patch: patch_campaign +/dfareporting:v2.7/dfareporting.campaigns.patch/id: id +/dfareporting:v2.7/dfareporting.campaigns.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.campaigns.update: update_campaign +/dfareporting:v2.7/dfareporting.campaigns.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.get: get_change_log +/dfareporting:v2.7/dfareporting.changeLogs.get/id: id +/dfareporting:v2.7/dfareporting.changeLogs.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.list: list_change_logs +/dfareporting:v2.7/dfareporting.changeLogs.list/action: action +/dfareporting:v2.7/dfareporting.changeLogs.list/ids: ids +/dfareporting:v2.7/dfareporting.changeLogs.list/maxChangeTime: max_change_time +/dfareporting:v2.7/dfareporting.changeLogs.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.changeLogs.list/minChangeTime: min_change_time +/dfareporting:v2.7/dfareporting.changeLogs.list/objectIds: object_ids +/dfareporting:v2.7/dfareporting.changeLogs.list/objectType: object_type +/dfareporting:v2.7/dfareporting.changeLogs.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.changeLogs.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.changeLogs.list/searchString: search_string +/dfareporting:v2.7/dfareporting.changeLogs.list/userProfileIds: user_profile_ids +/dfareporting:v2.7/dfareporting.cities.list: list_cities +/dfareporting:v2.7/dfareporting.cities.list/countryDartIds: country_dart_ids +/dfareporting:v2.7/dfareporting.cities.list/dartIds: dart_ids +/dfareporting:v2.7/dfareporting.cities.list/namePrefix: name_prefix +/dfareporting:v2.7/dfareporting.cities.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.cities.list/regionDartIds: region_dart_ids +/dfareporting:v2.7/dfareporting.connectionTypes.get: get_connection_type +/dfareporting:v2.7/dfareporting.connectionTypes.get/id: id +/dfareporting:v2.7/dfareporting.connectionTypes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.connectionTypes.list: list_connection_types +/dfareporting:v2.7/dfareporting.connectionTypes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.delete: delete_content_category +/dfareporting:v2.7/dfareporting.contentCategories.delete/id: id +/dfareporting:v2.7/dfareporting.contentCategories.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.get: get_content_category +/dfareporting:v2.7/dfareporting.contentCategories.get/id: id +/dfareporting:v2.7/dfareporting.contentCategories.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.insert: insert_content_category +/dfareporting:v2.7/dfareporting.contentCategories.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.list: list_content_categories +/dfareporting:v2.7/dfareporting.contentCategories.list/ids: ids +/dfareporting:v2.7/dfareporting.contentCategories.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.contentCategories.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.contentCategories.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.list/searchString: search_string +/dfareporting:v2.7/dfareporting.contentCategories.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.contentCategories.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.contentCategories.patch: patch_content_category +/dfareporting:v2.7/dfareporting.contentCategories.patch/id: id +/dfareporting:v2.7/dfareporting.contentCategories.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.contentCategories.update: update_content_category +/dfareporting:v2.7/dfareporting.contentCategories.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.conversions.batchinsert: batchinsert_conversion +/dfareporting:v2.7/dfareporting.conversions.batchinsert/profileId: profile_id +/dfareporting:v2.7/dfareporting.countries.get: get_country +/dfareporting:v2.7/dfareporting.countries.get/dartId: dart_id +/dfareporting:v2.7/dfareporting.countries.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.countries.list: list_countries +/dfareporting:v2.7/dfareporting.countries.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeAssets.insert: insert_creative_asset +/dfareporting:v2.7/dfareporting.creativeAssets.insert/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.creativeAssets.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete: delete_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get: get_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert: insert_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list: list_creative_field_values +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeFieldValues.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch: patch_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/id: id +/dfareporting:v2.7/dfareporting.creativeFieldValues.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.update: update_creative_field_value +/dfareporting:v2.7/dfareporting.creativeFieldValues.update/creativeFieldId: creative_field_id +/dfareporting:v2.7/dfareporting.creativeFieldValues.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.delete: delete_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.delete/id: id +/dfareporting:v2.7/dfareporting.creativeFields.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.get: get_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.get/id: id +/dfareporting:v2.7/dfareporting.creativeFields.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.insert: insert_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.list: list_creative_fields +/dfareporting:v2.7/dfareporting.creativeFields.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.creativeFields.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeFields.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeFields.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeFields.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeFields.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeFields.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeFields.patch: patch_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.patch/id: id +/dfareporting:v2.7/dfareporting.creativeFields.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeFields.update: update_creative_field +/dfareporting:v2.7/dfareporting.creativeFields.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.get: get_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.get/id: id +/dfareporting:v2.7/dfareporting.creativeGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.insert: insert_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.list: list_creative_groups +/dfareporting:v2.7/dfareporting.creativeGroups.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.creativeGroups.list/groupNumber: group_number +/dfareporting:v2.7/dfareporting.creativeGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.creativeGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creativeGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creativeGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creativeGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creativeGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creativeGroups.patch: patch_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.patch/id: id +/dfareporting:v2.7/dfareporting.creativeGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creativeGroups.update: update_creative_group +/dfareporting:v2.7/dfareporting.creativeGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.get: get_creative +/dfareporting:v2.7/dfareporting.creatives.get/id: id +/dfareporting:v2.7/dfareporting.creatives.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.insert: insert_creative +/dfareporting:v2.7/dfareporting.creatives.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.list: list_creatives +/dfareporting:v2.7/dfareporting.creatives.list/active: active +/dfareporting:v2.7/dfareporting.creatives.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.creatives.list/archived: archived +/dfareporting:v2.7/dfareporting.creatives.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.creatives.list/companionCreativeIds: companion_creative_ids +/dfareporting:v2.7/dfareporting.creatives.list/creativeFieldIds: creative_field_ids +/dfareporting:v2.7/dfareporting.creatives.list/ids: ids +/dfareporting:v2.7/dfareporting.creatives.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.creatives.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.creatives.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.list/renderingIds: rendering_ids +/dfareporting:v2.7/dfareporting.creatives.list/searchString: search_string +/dfareporting:v2.7/dfareporting.creatives.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.creatives.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.creatives.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.creatives.list/studioCreativeId: studio_creative_id +/dfareporting:v2.7/dfareporting.creatives.list/types: types +/dfareporting:v2.7/dfareporting.creatives.patch: patch_creative +/dfareporting:v2.7/dfareporting.creatives.patch/id: id +/dfareporting:v2.7/dfareporting.creatives.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.creatives.update: update_creative +/dfareporting:v2.7/dfareporting.creatives.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.dimensionValues.query: query_dimension_value +/dfareporting:v2.7/dfareporting.dimensionValues.query/maxResults: max_results +/dfareporting:v2.7/dfareporting.dimensionValues.query/pageToken: page_token +/dfareporting:v2.7/dfareporting.dimensionValues.query/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.get: get_directory_site_contact +/dfareporting:v2.7/dfareporting.directorySiteContacts.get/id: id +/dfareporting:v2.7/dfareporting.directorySiteContacts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.list: list_directory_site_contacts +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/ids: ids +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.directorySiteContacts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.directorySites.get: get_directory_site +/dfareporting:v2.7/dfareporting.directorySites.get/id: id +/dfareporting:v2.7/dfareporting.directorySites.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.insert: insert_directory_site +/dfareporting:v2.7/dfareporting.directorySites.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.list: list_directory_sites +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsInStreamVideoPlacements: accepts_in_stream_video_placements +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsInterstitialPlacements: accepts_interstitial_placements +/dfareporting:v2.7/dfareporting.directorySites.list/acceptsPublisherPaidPlacements: accepts_publisher_paid_placements +/dfareporting:v2.7/dfareporting.directorySites.list/active: active +/dfareporting:v2.7/dfareporting.directorySites.list/countryId: country_id +/dfareporting:v2.7/dfareporting.directorySites.list/dfp_network_code: dfp_network_code +/dfareporting:v2.7/dfareporting.directorySites.list/ids: ids +/dfareporting:v2.7/dfareporting.directorySites.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.directorySites.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.directorySites.list/parentId: parent_id +/dfareporting:v2.7/dfareporting.directorySites.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.directorySites.list/searchString: search_string +/dfareporting:v2.7/dfareporting.directorySites.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.directorySites.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete: delete_dynamic_targeting_key +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/name: name +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/objectId: object_id_ +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/objectType: object_type +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.insert: insert_dynamic_targeting_key +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list: list_dynamic_targeting_keys +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/names: names +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/objectId: object_id_ +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/objectType: object_type +/dfareporting:v2.7/dfareporting.dynamicTargetingKeys.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.delete: delete_event_tag +/dfareporting:v2.7/dfareporting.eventTags.delete/id: id +/dfareporting:v2.7/dfareporting.eventTags.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.get: get_event_tag +/dfareporting:v2.7/dfareporting.eventTags.get/id: id +/dfareporting:v2.7/dfareporting.eventTags.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.insert: insert_event_tag +/dfareporting:v2.7/dfareporting.eventTags.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.list: list_event_tags +/dfareporting:v2.7/dfareporting.eventTags.list/adId: ad_id +/dfareporting:v2.7/dfareporting.eventTags.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.eventTags.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.eventTags.list/definitionsOnly: definitions_only +/dfareporting:v2.7/dfareporting.eventTags.list/enabled: enabled +/dfareporting:v2.7/dfareporting.eventTags.list/eventTagTypes: event_tag_types +/dfareporting:v2.7/dfareporting.eventTags.list/ids: ids +/dfareporting:v2.7/dfareporting.eventTags.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.list/searchString: search_string +/dfareporting:v2.7/dfareporting.eventTags.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.eventTags.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.eventTags.patch: patch_event_tag +/dfareporting:v2.7/dfareporting.eventTags.patch/id: id +/dfareporting:v2.7/dfareporting.eventTags.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.eventTags.update: update_event_tag +/dfareporting:v2.7/dfareporting.eventTags.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.files.get: get_file +/dfareporting:v2.7/dfareporting.files.get/fileId: file_id +/dfareporting:v2.7/dfareporting.files.get/reportId: report_id +/dfareporting:v2.7/dfareporting.files.list: list_files +/dfareporting:v2.7/dfareporting.files.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.files.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.files.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.files.list/scope: scope +/dfareporting:v2.7/dfareporting.files.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.files.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivities.delete: delete_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.delete/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag: generatetag_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/dfareporting.floodlightActivities.generatetag/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.get: get_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.get/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.insert: insert_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list: list_floodlight_activities +/dfareporting:v2.7/dfareporting.floodlightActivities.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupIds: floodlight_activity_group_ids +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupName: floodlight_activity_group_name +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupTagString: floodlight_activity_group_tag_string +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightActivityGroupType: floodlight_activity_group_type +/dfareporting:v2.7/dfareporting.floodlightActivities.list/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightActivities.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.floodlightActivities.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.floodlightActivities.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.list/searchString: search_string +/dfareporting:v2.7/dfareporting.floodlightActivities.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.floodlightActivities.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivities.list/tagString: tag_string +/dfareporting:v2.7/dfareporting.floodlightActivities.patch: patch_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightActivities.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivities.update: update_floodlight_activity +/dfareporting:v2.7/dfareporting.floodlightActivities.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get: get_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get/id: id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.insert: insert_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list: list_floodlight_activity_groups +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.list/type: type +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch: patch_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.update: update_floodlight_activity_group +/dfareporting:v2.7/dfareporting.floodlightActivityGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get: get_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get/id: id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list: list_floodlight_configurations +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list/ids: ids +/dfareporting:v2.7/dfareporting.floodlightConfigurations.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch: patch_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch/id: id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.floodlightConfigurations.update: update_floodlight_configuration +/dfareporting:v2.7/dfareporting.floodlightConfigurations.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.get: get_inventory_item +/dfareporting:v2.7/dfareporting.inventoryItems.get/id: id +/dfareporting:v2.7/dfareporting.inventoryItems.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.get/projectId: project_id +/dfareporting:v2.7/dfareporting.inventoryItems.list: list_inventory_items +/dfareporting:v2.7/dfareporting.inventoryItems.list/ids: ids +/dfareporting:v2.7/dfareporting.inventoryItems.list/inPlan: in_plan +/dfareporting:v2.7/dfareporting.inventoryItems.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.inventoryItems.list/orderId: order_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.inventoryItems.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/projectId: project_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/siteId: site_id +/dfareporting:v2.7/dfareporting.inventoryItems.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.inventoryItems.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.inventoryItems.list/type: type +/dfareporting:v2.7/dfareporting.landingPages.delete: delete_landing_page +/dfareporting:v2.7/dfareporting.landingPages.delete/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.delete/id: id +/dfareporting:v2.7/dfareporting.landingPages.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.get: get_landing_page +/dfareporting:v2.7/dfareporting.landingPages.get/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.get/id: id +/dfareporting:v2.7/dfareporting.landingPages.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.insert: insert_landing_page +/dfareporting:v2.7/dfareporting.landingPages.insert/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.list: list_landing_pages +/dfareporting:v2.7/dfareporting.landingPages.list/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.patch: patch_landing_page +/dfareporting:v2.7/dfareporting.landingPages.patch/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.patch/id: id +/dfareporting:v2.7/dfareporting.landingPages.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.landingPages.update: update_landing_page +/dfareporting:v2.7/dfareporting.landingPages.update/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.landingPages.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.languages.list: list_languages +/dfareporting:v2.7/dfareporting.languages.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.metros.list: list_metros +/dfareporting:v2.7/dfareporting.metros.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.mobileCarriers.get: get_mobile_carrier +/dfareporting:v2.7/dfareporting.mobileCarriers.get/id: id +/dfareporting:v2.7/dfareporting.mobileCarriers.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.mobileCarriers.list: list_mobile_carriers +/dfareporting:v2.7/dfareporting.mobileCarriers.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get: get_operating_system_version +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get/id: id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystemVersions.list: list_operating_system_versions +/dfareporting:v2.7/dfareporting.operatingSystemVersions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystems.get: get_operating_system +/dfareporting:v2.7/dfareporting.operatingSystems.get/dartId: dart_id +/dfareporting:v2.7/dfareporting.operatingSystems.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.operatingSystems.list: list_operating_systems +/dfareporting:v2.7/dfareporting.operatingSystems.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.get: get_order_document +/dfareporting:v2.7/dfareporting.orderDocuments.get/id: id +/dfareporting:v2.7/dfareporting.orderDocuments.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.get/projectId: project_id +/dfareporting:v2.7/dfareporting.orderDocuments.list: list_order_documents +/dfareporting:v2.7/dfareporting.orderDocuments.list/approved: approved +/dfareporting:v2.7/dfareporting.orderDocuments.list/ids: ids +/dfareporting:v2.7/dfareporting.orderDocuments.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.orderDocuments.list/orderId: order_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.orderDocuments.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/projectId: project_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/searchString: search_string +/dfareporting:v2.7/dfareporting.orderDocuments.list/siteId: site_id +/dfareporting:v2.7/dfareporting.orderDocuments.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.orderDocuments.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.orders.get: get_order +/dfareporting:v2.7/dfareporting.orders.get/id: id +/dfareporting:v2.7/dfareporting.orders.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.orders.get/projectId: project_id +/dfareporting:v2.7/dfareporting.orders.list: list_orders +/dfareporting:v2.7/dfareporting.orders.list/ids: ids +/dfareporting:v2.7/dfareporting.orders.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.orders.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.orders.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.orders.list/projectId: project_id +/dfareporting:v2.7/dfareporting.orders.list/searchString: search_string +/dfareporting:v2.7/dfareporting.orders.list/siteId: site_id +/dfareporting:v2.7/dfareporting.orders.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.orders.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementGroups.get: get_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.get/id: id +/dfareporting:v2.7/dfareporting.placementGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.insert: insert_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.list: list_placement_groups +/dfareporting:v2.7/dfareporting.placementGroups.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/archived: archived +/dfareporting:v2.7/dfareporting.placementGroups.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/contentCategoryIds: content_category_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/ids: ids +/dfareporting:v2.7/dfareporting.placementGroups.list/maxEndDate: max_end_date +/dfareporting:v2.7/dfareporting.placementGroups.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placementGroups.list/maxStartDate: max_start_date +/dfareporting:v2.7/dfareporting.placementGroups.list/minEndDate: min_end_date +/dfareporting:v2.7/dfareporting.placementGroups.list/minStartDate: min_start_date +/dfareporting:v2.7/dfareporting.placementGroups.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placementGroups.list/placementGroupType: placement_group_type +/dfareporting:v2.7/dfareporting.placementGroups.list/placementStrategyIds: placement_strategy_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/pricingTypes: pricing_types +/dfareporting:v2.7/dfareporting.placementGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placementGroups.list/siteIds: site_ids +/dfareporting:v2.7/dfareporting.placementGroups.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placementGroups.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementGroups.patch: patch_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.patch/id: id +/dfareporting:v2.7/dfareporting.placementGroups.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementGroups.update: update_placement_group +/dfareporting:v2.7/dfareporting.placementGroups.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.delete: delete_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.delete/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.get: get_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.get/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.insert: insert_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.list: list_placement_strategies +/dfareporting:v2.7/dfareporting.placementStrategies.list/ids: ids +/dfareporting:v2.7/dfareporting.placementStrategies.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placementStrategies.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placementStrategies.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placementStrategies.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placementStrategies.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placementStrategies.patch: patch_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.patch/id: id +/dfareporting:v2.7/dfareporting.placementStrategies.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placementStrategies.update: update_placement_strategy +/dfareporting:v2.7/dfareporting.placementStrategies.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.generatetags: generatetags_placement +/dfareporting:v2.7/dfareporting.placements.generatetags/campaignId: campaign_id +/dfareporting:v2.7/dfareporting.placements.generatetags/placementIds: placement_ids +/dfareporting:v2.7/dfareporting.placements.generatetags/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.generatetags/tagFormats: tag_formats +/dfareporting:v2.7/dfareporting.placements.get: get_placement +/dfareporting:v2.7/dfareporting.placements.get/id: id +/dfareporting:v2.7/dfareporting.placements.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.insert: insert_placement +/dfareporting:v2.7/dfareporting.placements.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.list: list_placements +/dfareporting:v2.7/dfareporting.placements.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.placements.list/archived: archived +/dfareporting:v2.7/dfareporting.placements.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.placements.list/compatibilities: compatibilities +/dfareporting:v2.7/dfareporting.placements.list/contentCategoryIds: content_category_ids +/dfareporting:v2.7/dfareporting.placements.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.placements.list/groupIds: group_ids +/dfareporting:v2.7/dfareporting.placements.list/ids: ids +/dfareporting:v2.7/dfareporting.placements.list/maxEndDate: max_end_date +/dfareporting:v2.7/dfareporting.placements.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.placements.list/maxStartDate: max_start_date +/dfareporting:v2.7/dfareporting.placements.list/minEndDate: min_end_date +/dfareporting:v2.7/dfareporting.placements.list/minStartDate: min_start_date +/dfareporting:v2.7/dfareporting.placements.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.placements.list/paymentSource: payment_source +/dfareporting:v2.7/dfareporting.placements.list/placementStrategyIds: placement_strategy_ids +/dfareporting:v2.7/dfareporting.placements.list/pricingTypes: pricing_types +/dfareporting:v2.7/dfareporting.placements.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.list/searchString: search_string +/dfareporting:v2.7/dfareporting.placements.list/siteIds: site_ids +/dfareporting:v2.7/dfareporting.placements.list/sizeIds: size_ids +/dfareporting:v2.7/dfareporting.placements.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.placements.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.placements.patch: patch_placement +/dfareporting:v2.7/dfareporting.placements.patch/id: id +/dfareporting:v2.7/dfareporting.placements.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.placements.update: update_placement +/dfareporting:v2.7/dfareporting.placements.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.platformTypes.get: get_platform_type +/dfareporting:v2.7/dfareporting.platformTypes.get/id: id +/dfareporting:v2.7/dfareporting.platformTypes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.platformTypes.list: list_platform_types +/dfareporting:v2.7/dfareporting.platformTypes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.postalCodes.get: get_postal_code +/dfareporting:v2.7/dfareporting.postalCodes.get/code: code +/dfareporting:v2.7/dfareporting.postalCodes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.postalCodes.list: list_postal_codes +/dfareporting:v2.7/dfareporting.postalCodes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.get: get_project +/dfareporting:v2.7/dfareporting.projects.get/id: id +/dfareporting:v2.7/dfareporting.projects.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.list: list_projects +/dfareporting:v2.7/dfareporting.projects.list/advertiserIds: advertiser_ids +/dfareporting:v2.7/dfareporting.projects.list/ids: ids +/dfareporting:v2.7/dfareporting.projects.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.projects.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.projects.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.projects.list/searchString: search_string +/dfareporting:v2.7/dfareporting.projects.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.projects.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.regions.list: list_regions +/dfareporting:v2.7/dfareporting.regions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.get: get_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.get/remarketingListId: remarketing_list_id +/dfareporting:v2.7/dfareporting.remarketingListShares.patch: patch_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingListShares.patch/remarketingListId: remarketing_list_id +/dfareporting:v2.7/dfareporting.remarketingListShares.update: update_remarketing_list_share +/dfareporting:v2.7/dfareporting.remarketingListShares.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.get: get_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.get/id: id +/dfareporting:v2.7/dfareporting.remarketingLists.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.insert: insert_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.list: list_remarketing_lists +/dfareporting:v2.7/dfareporting.remarketingLists.list/active: active +/dfareporting:v2.7/dfareporting.remarketingLists.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.remarketingLists.list/name: name +/dfareporting:v2.7/dfareporting.remarketingLists.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.remarketingLists.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.remarketingLists.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.remarketingLists.patch: patch_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.patch/id: id +/dfareporting:v2.7/dfareporting.remarketingLists.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.remarketingLists.update: update_remarketing_list +/dfareporting:v2.7/dfareporting.remarketingLists.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.delete: delete_report +/dfareporting:v2.7/dfareporting.reports.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.delete/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.get: get_report +/dfareporting:v2.7/dfareporting.reports.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.get/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.insert: insert_report +/dfareporting:v2.7/dfareporting.reports.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.list: list_reports +/dfareporting:v2.7/dfareporting.reports.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.reports.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.reports.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.list/scope: scope +/dfareporting:v2.7/dfareporting.reports.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.reports.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.reports.patch: patch_report +/dfareporting:v2.7/dfareporting.reports.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.patch/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.run: run_report +/dfareporting:v2.7/dfareporting.reports.run/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.run/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.run/synchronous: synchronous +/dfareporting:v2.7/dfareporting.reports.update: update_report +/dfareporting:v2.7/dfareporting.reports.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.update/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.compatibleFields.query: query_report_compatible_field +/dfareporting:v2.7/dfareporting.reports.compatibleFields.query/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.get: get_report_file +/dfareporting:v2.7/dfareporting.reports.files.get/fileId: file_id +/dfareporting:v2.7/dfareporting.reports.files.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.get/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.files.list: list_report_files +/dfareporting:v2.7/dfareporting.reports.files.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.reports.files.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.reports.files.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.reports.files.list/reportId: report_id +/dfareporting:v2.7/dfareporting.reports.files.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.reports.files.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.sites.get: get_site +/dfareporting:v2.7/dfareporting.sites.get/id: id +/dfareporting:v2.7/dfareporting.sites.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.insert: insert_site +/dfareporting:v2.7/dfareporting.sites.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.list: list_sites +/dfareporting:v2.7/dfareporting.sites.list/acceptsInStreamVideoPlacements: accepts_in_stream_video_placements +/dfareporting:v2.7/dfareporting.sites.list/acceptsInterstitialPlacements: accepts_interstitial_placements +/dfareporting:v2.7/dfareporting.sites.list/acceptsPublisherPaidPlacements: accepts_publisher_paid_placements +/dfareporting:v2.7/dfareporting.sites.list/adWordsSite: ad_words_site +/dfareporting:v2.7/dfareporting.sites.list/approved: approved +/dfareporting:v2.7/dfareporting.sites.list/campaignIds: campaign_ids +/dfareporting:v2.7/dfareporting.sites.list/directorySiteIds: directory_site_ids +/dfareporting:v2.7/dfareporting.sites.list/ids: ids +/dfareporting:v2.7/dfareporting.sites.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.sites.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.sites.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.list/searchString: search_string +/dfareporting:v2.7/dfareporting.sites.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.sites.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.sites.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.sites.list/unmappedSite: unmapped_site +/dfareporting:v2.7/dfareporting.sites.patch: patch_site +/dfareporting:v2.7/dfareporting.sites.patch/id: id +/dfareporting:v2.7/dfareporting.sites.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.sites.update: update_site +/dfareporting:v2.7/dfareporting.sites.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.get: get_size +/dfareporting:v2.7/dfareporting.sizes.get/id: id +/dfareporting:v2.7/dfareporting.sizes.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.insert: insert_size +/dfareporting:v2.7/dfareporting.sizes.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.list: list_sizes +/dfareporting:v2.7/dfareporting.sizes.list/height: height +/dfareporting:v2.7/dfareporting.sizes.list/iabStandard: iab_standard +/dfareporting:v2.7/dfareporting.sizes.list/ids: ids +/dfareporting:v2.7/dfareporting.sizes.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.sizes.list/width: width +/dfareporting:v2.7/dfareporting.subaccounts.get: get_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.get/id: id +/dfareporting:v2.7/dfareporting.subaccounts.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.insert: insert_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.list: list_subaccounts +/dfareporting:v2.7/dfareporting.subaccounts.list/ids: ids +/dfareporting:v2.7/dfareporting.subaccounts.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.subaccounts.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.subaccounts.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.list/searchString: search_string +/dfareporting:v2.7/dfareporting.subaccounts.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.subaccounts.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.subaccounts.patch: patch_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.patch/id: id +/dfareporting:v2.7/dfareporting.subaccounts.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.subaccounts.update: update_subaccount +/dfareporting:v2.7/dfareporting.subaccounts.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get: get_targetable_remarketing_list +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get/id: id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list: list_targetable_remarketing_lists +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/active: active +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/name: name +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.targetableRemarketingLists.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.targetingTemplates.get: get_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.get/id: id +/dfareporting:v2.7/dfareporting.targetingTemplates.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.insert: insert_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list: list_targeting_templates +/dfareporting:v2.7/dfareporting.targetingTemplates.list/advertiserId: advertiser_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list/ids: ids +/dfareporting:v2.7/dfareporting.targetingTemplates.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.targetingTemplates.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.targetingTemplates.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.list/searchString: search_string +/dfareporting:v2.7/dfareporting.targetingTemplates.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.targetingTemplates.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.targetingTemplates.patch: patch_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.patch/id: id +/dfareporting:v2.7/dfareporting.targetingTemplates.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.targetingTemplates.update: update_targeting_template +/dfareporting:v2.7/dfareporting.targetingTemplates.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.userProfiles.get: get_user_profile +/dfareporting:v2.7/dfareporting.userProfiles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userProfiles.list: list_user_profiles +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get: get_user_role_permission_group +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get/id: id +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.list: list_user_role_permission_groups +/dfareporting:v2.7/dfareporting.userRolePermissionGroups.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissions.get: get_user_role_permission +/dfareporting:v2.7/dfareporting.userRolePermissions.get/id: id +/dfareporting:v2.7/dfareporting.userRolePermissions.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRolePermissions.list: list_user_role_permissions +/dfareporting:v2.7/dfareporting.userRolePermissions.list/ids: ids +/dfareporting:v2.7/dfareporting.userRolePermissions.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.delete: delete_user_role +/dfareporting:v2.7/dfareporting.userRoles.delete/id: id +/dfareporting:v2.7/dfareporting.userRoles.delete/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.get: get_user_role +/dfareporting:v2.7/dfareporting.userRoles.get/id: id +/dfareporting:v2.7/dfareporting.userRoles.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.insert: insert_user_role +/dfareporting:v2.7/dfareporting.userRoles.insert/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.list: list_user_roles +/dfareporting:v2.7/dfareporting.userRoles.list/accountUserRoleOnly: account_user_role_only +/dfareporting:v2.7/dfareporting.userRoles.list/ids: ids +/dfareporting:v2.7/dfareporting.userRoles.list/maxResults: max_results +/dfareporting:v2.7/dfareporting.userRoles.list/pageToken: page_token +/dfareporting:v2.7/dfareporting.userRoles.list/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.list/searchString: search_string +/dfareporting:v2.7/dfareporting.userRoles.list/sortField: sort_field +/dfareporting:v2.7/dfareporting.userRoles.list/sortOrder: sort_order +/dfareporting:v2.7/dfareporting.userRoles.list/subaccountId: subaccount_id +/dfareporting:v2.7/dfareporting.userRoles.patch: patch_user_role +/dfareporting:v2.7/dfareporting.userRoles.patch/id: id +/dfareporting:v2.7/dfareporting.userRoles.patch/profileId: profile_id +/dfareporting:v2.7/dfareporting.userRoles.update: update_user_role +/dfareporting:v2.7/dfareporting.userRoles.update/profileId: profile_id +/dfareporting:v2.7/dfareporting.videoFormats.get: get_video_format +/dfareporting:v2.7/dfareporting.videoFormats.get/id: id +/dfareporting:v2.7/dfareporting.videoFormats.get/profileId: profile_id +/dfareporting:v2.7/dfareporting.videoFormats.list: list_video_formats +/dfareporting:v2.7/dfareporting.videoFormats.list/profileId: profile_id +/dfareporting:v2.7/Account: account +/dfareporting:v2.7/Account/accountPermissionIds: account_permission_ids +/dfareporting:v2.7/Account/accountPermissionIds/account_permission_id: account_permission_id +/dfareporting:v2.7/Account/accountProfile: account_profile +/dfareporting:v2.7/Account/active: active +/dfareporting:v2.7/Account/activeAdsLimitTier: active_ads_limit_tier +/dfareporting:v2.7/Account/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/Account/availablePermissionIds: available_permission_ids +/dfareporting:v2.7/Account/availablePermissionIds/available_permission_id: available_permission_id +/dfareporting:v2.7/Account/countryId: country_id +/dfareporting:v2.7/Account/currencyId: currency_id +/dfareporting:v2.7/Account/defaultCreativeSizeId: default_creative_size_id +/dfareporting:v2.7/Account/description: description +/dfareporting:v2.7/Account/id: id +/dfareporting:v2.7/Account/kind: kind +/dfareporting:v2.7/Account/locale: locale +/dfareporting:v2.7/Account/maximumImageSize: maximum_image_size +/dfareporting:v2.7/Account/name: name +/dfareporting:v2.7/Account/nielsenOcrEnabled: nielsen_ocr_enabled +/dfareporting:v2.7/Account/reportsConfiguration: reports_configuration +/dfareporting:v2.7/Account/shareReportsWithTwitter: share_reports_with_twitter +/dfareporting:v2.7/Account/teaserSizeLimit: teaser_size_limit +/dfareporting:v2.7/AccountActiveAdSummary: account_active_ad_summary +/dfareporting:v2.7/AccountActiveAdSummary/accountId: account_id +/dfareporting:v2.7/AccountActiveAdSummary/activeAds: active_ads +/dfareporting:v2.7/AccountActiveAdSummary/activeAdsLimitTier: active_ads_limit_tier +/dfareporting:v2.7/AccountActiveAdSummary/availableAds: available_ads +/dfareporting:v2.7/AccountActiveAdSummary/kind: kind +/dfareporting:v2.7/AccountPermission: account_permission +/dfareporting:v2.7/AccountPermission/accountProfiles: account_profiles +/dfareporting:v2.7/AccountPermission/accountProfiles/account_profile: account_profile +/dfareporting:v2.7/AccountPermission/id: id +/dfareporting:v2.7/AccountPermission/kind: kind +/dfareporting:v2.7/AccountPermission/level: level +/dfareporting:v2.7/AccountPermission/name: name +/dfareporting:v2.7/AccountPermission/permissionGroupId: permission_group_id +/dfareporting:v2.7/AccountPermissionGroup: account_permission_group +/dfareporting:v2.7/AccountPermissionGroup/id: id +/dfareporting:v2.7/AccountPermissionGroup/kind: kind +/dfareporting:v2.7/AccountPermissionGroup/name: name +/dfareporting:v2.7/AccountPermissionGroupsListResponse: account_permission_groups_list_response +/dfareporting:v2.7/AccountPermissionGroupsListResponse/accountPermissionGroups: account_permission_groups +/dfareporting:v2.7/AccountPermissionGroupsListResponse/accountPermissionGroups/account_permission_group: account_permission_group +/dfareporting:v2.7/AccountPermissionGroupsListResponse/kind: kind +/dfareporting:v2.7/AccountPermissionsListResponse: account_permissions_list_response +/dfareporting:v2.7/AccountPermissionsListResponse/accountPermissions: account_permissions +/dfareporting:v2.7/AccountPermissionsListResponse/accountPermissions/account_permission: account_permission +/dfareporting:v2.7/AccountPermissionsListResponse/kind: kind +/dfareporting:v2.7/AccountUserProfile: account_user_profile +/dfareporting:v2.7/AccountUserProfile/accountId: account_id +/dfareporting:v2.7/AccountUserProfile/active: active +/dfareporting:v2.7/AccountUserProfile/advertiserFilter: advertiser_filter +/dfareporting:v2.7/AccountUserProfile/campaignFilter: campaign_filter +/dfareporting:v2.7/AccountUserProfile/comments: comments +/dfareporting:v2.7/AccountUserProfile/email: email +/dfareporting:v2.7/AccountUserProfile/id: id +/dfareporting:v2.7/AccountUserProfile/kind: kind +/dfareporting:v2.7/AccountUserProfile/locale: locale +/dfareporting:v2.7/AccountUserProfile/name: name +/dfareporting:v2.7/AccountUserProfile/siteFilter: site_filter +/dfareporting:v2.7/AccountUserProfile/subaccountId: subaccount_id +/dfareporting:v2.7/AccountUserProfile/traffickerType: trafficker_type +/dfareporting:v2.7/AccountUserProfile/userAccessType: user_access_type +/dfareporting:v2.7/AccountUserProfile/userRoleFilter: user_role_filter +/dfareporting:v2.7/AccountUserProfile/userRoleId: user_role_id +/dfareporting:v2.7/AccountUserProfilesListResponse: account_user_profiles_list_response +/dfareporting:v2.7/AccountUserProfilesListResponse/accountUserProfiles: account_user_profiles +/dfareporting:v2.7/AccountUserProfilesListResponse/accountUserProfiles/account_user_profile: account_user_profile +/dfareporting:v2.7/AccountUserProfilesListResponse/kind: kind +/dfareporting:v2.7/AccountUserProfilesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AccountsListResponse: accounts_list_response +/dfareporting:v2.7/AccountsListResponse/accounts: accounts +/dfareporting:v2.7/AccountsListResponse/accounts/account: account +/dfareporting:v2.7/AccountsListResponse/kind: kind +/dfareporting:v2.7/AccountsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/Activities: activities +/dfareporting:v2.7/Activities/filters: filters +/dfareporting:v2.7/Activities/filters/filter: filter +/dfareporting:v2.7/Activities/kind: kind +/dfareporting:v2.7/Activities/metricNames: metric_names +/dfareporting:v2.7/Activities/metricNames/metric_name: metric_name +/dfareporting:v2.7/Ad: ad +/dfareporting:v2.7/Ad/accountId: account_id +/dfareporting:v2.7/Ad/active: active +/dfareporting:v2.7/Ad/advertiserId: advertiser_id +/dfareporting:v2.7/Ad/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Ad/archived: archived +/dfareporting:v2.7/Ad/audienceSegmentId: audience_segment_id +/dfareporting:v2.7/Ad/campaignId: campaign_id +/dfareporting:v2.7/Ad/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/Ad/clickThroughUrl: click_through_url +/dfareporting:v2.7/Ad/clickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/Ad/comments: comments +/dfareporting:v2.7/Ad/compatibility: compatibility +/dfareporting:v2.7/Ad/createInfo: create_info +/dfareporting:v2.7/Ad/creativeGroupAssignments: creative_group_assignments +/dfareporting:v2.7/Ad/creativeGroupAssignments/creative_group_assignment: creative_group_assignment +/dfareporting:v2.7/Ad/creativeRotation: creative_rotation +/dfareporting:v2.7/Ad/dayPartTargeting: day_part_targeting +/dfareporting:v2.7/Ad/defaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/Ad/deliverySchedule: delivery_schedule +/dfareporting:v2.7/Ad/dynamicClickTracker: dynamic_click_tracker +/dfareporting:v2.7/Ad/endTime: end_time +/dfareporting:v2.7/Ad/eventTagOverrides: event_tag_overrides +/dfareporting:v2.7/Ad/eventTagOverrides/event_tag_override: event_tag_override +/dfareporting:v2.7/Ad/geoTargeting: geo_targeting +/dfareporting:v2.7/Ad/id: id +/dfareporting:v2.7/Ad/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Ad/keyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/Ad/kind: kind +/dfareporting:v2.7/Ad/languageTargeting: language_targeting +/dfareporting:v2.7/Ad/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Ad/name: name +/dfareporting:v2.7/Ad/placementAssignments: placement_assignments +/dfareporting:v2.7/Ad/placementAssignments/placement_assignment: placement_assignment +/dfareporting:v2.7/Ad/remarketingListExpression: remarketing_list_expression +/dfareporting:v2.7/Ad/size: size +/dfareporting:v2.7/Ad/sslCompliant: ssl_compliant +/dfareporting:v2.7/Ad/sslRequired: ssl_required +/dfareporting:v2.7/Ad/startTime: start_time +/dfareporting:v2.7/Ad/subaccountId: subaccount_id +/dfareporting:v2.7/Ad/targetingTemplateId: targeting_template_id +/dfareporting:v2.7/Ad/technologyTargeting: technology_targeting +/dfareporting:v2.7/Ad/type: type +/dfareporting:v2.7/AdSlot: ad_slot +/dfareporting:v2.7/AdSlot/comment: comment +/dfareporting:v2.7/AdSlot/compatibility: compatibility +/dfareporting:v2.7/AdSlot/height: height +/dfareporting:v2.7/AdSlot/linkedPlacementId: linked_placement_id +/dfareporting:v2.7/AdSlot/name: name +/dfareporting:v2.7/AdSlot/paymentSourceType: payment_source_type +/dfareporting:v2.7/AdSlot/primary: primary +/dfareporting:v2.7/AdSlot/width: width +/dfareporting:v2.7/AdsListResponse: ads_list_response +/dfareporting:v2.7/AdsListResponse/ads: ads +/dfareporting:v2.7/AdsListResponse/ads/ad: ad +/dfareporting:v2.7/AdsListResponse/kind: kind +/dfareporting:v2.7/AdsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/Advertiser: advertiser +/dfareporting:v2.7/Advertiser/accountId: account_id +/dfareporting:v2.7/Advertiser/advertiserGroupId: advertiser_group_id +/dfareporting:v2.7/Advertiser/clickThroughUrlSuffix: click_through_url_suffix +/dfareporting:v2.7/Advertiser/defaultClickThroughEventTagId: default_click_through_event_tag_id +/dfareporting:v2.7/Advertiser/defaultEmail: default_email +/dfareporting:v2.7/Advertiser/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/Advertiser/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/Advertiser/id: id +/dfareporting:v2.7/Advertiser/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Advertiser/kind: kind +/dfareporting:v2.7/Advertiser/name: name +/dfareporting:v2.7/Advertiser/originalFloodlightConfigurationId: original_floodlight_configuration_id +/dfareporting:v2.7/Advertiser/status: status +/dfareporting:v2.7/Advertiser/subaccountId: subaccount_id +/dfareporting:v2.7/Advertiser/suspended: suspended +/dfareporting:v2.7/AdvertiserGroup: advertiser_group +/dfareporting:v2.7/AdvertiserGroup/accountId: account_id +/dfareporting:v2.7/AdvertiserGroup/id: id +/dfareporting:v2.7/AdvertiserGroup/kind: kind +/dfareporting:v2.7/AdvertiserGroup/name: name +/dfareporting:v2.7/AdvertiserGroupsListResponse: advertiser_groups_list_response +/dfareporting:v2.7/AdvertiserGroupsListResponse/advertiserGroups: advertiser_groups +/dfareporting:v2.7/AdvertiserGroupsListResponse/advertiserGroups/advertiser_group: advertiser_group +/dfareporting:v2.7/AdvertiserGroupsListResponse/kind: kind +/dfareporting:v2.7/AdvertiserGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AdvertisersListResponse: advertisers_list_response +/dfareporting:v2.7/AdvertisersListResponse/advertisers: advertisers +/dfareporting:v2.7/AdvertisersListResponse/advertisers/advertiser: advertiser +/dfareporting:v2.7/AdvertisersListResponse/kind: kind +/dfareporting:v2.7/AdvertisersListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/AudienceSegment: audience_segment +/dfareporting:v2.7/AudienceSegment/allocation: allocation +/dfareporting:v2.7/AudienceSegment/id: id +/dfareporting:v2.7/AudienceSegment/name: name +/dfareporting:v2.7/AudienceSegmentGroup: audience_segment_group +/dfareporting:v2.7/AudienceSegmentGroup/audienceSegments: audience_segments +/dfareporting:v2.7/AudienceSegmentGroup/audienceSegments/audience_segment: audience_segment +/dfareporting:v2.7/AudienceSegmentGroup/id: id +/dfareporting:v2.7/AudienceSegmentGroup/name: name +/dfareporting:v2.7/Browser: browser +/dfareporting:v2.7/Browser/browserVersionId: browser_version_id +/dfareporting:v2.7/Browser/dartId: dart_id +/dfareporting:v2.7/Browser/kind: kind +/dfareporting:v2.7/Browser/majorVersion: major_version +/dfareporting:v2.7/Browser/minorVersion: minor_version +/dfareporting:v2.7/Browser/name: name +/dfareporting:v2.7/BrowsersListResponse: browsers_list_response +/dfareporting:v2.7/BrowsersListResponse/browsers: browsers +/dfareporting:v2.7/BrowsersListResponse/browsers/browser: browser +/dfareporting:v2.7/BrowsersListResponse/kind: kind +/dfareporting:v2.7/Campaign: campaign +/dfareporting:v2.7/Campaign/accountId: account_id +/dfareporting:v2.7/Campaign/additionalCreativeOptimizationConfigurations: additional_creative_optimization_configurations +/dfareporting:v2.7/Campaign/additionalCreativeOptimizationConfigurations/additional_creative_optimization_configuration: additional_creative_optimization_configuration +/dfareporting:v2.7/Campaign/advertiserGroupId: advertiser_group_id +/dfareporting:v2.7/Campaign/advertiserId: advertiser_id +/dfareporting:v2.7/Campaign/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Campaign/archived: archived +/dfareporting:v2.7/Campaign/audienceSegmentGroups: audience_segment_groups +/dfareporting:v2.7/Campaign/audienceSegmentGroups/audience_segment_group: audience_segment_group +/dfareporting:v2.7/Campaign/billingInvoiceCode: billing_invoice_code +/dfareporting:v2.7/Campaign/clickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/Campaign/comment: comment +/dfareporting:v2.7/Campaign/createInfo: create_info +/dfareporting:v2.7/Campaign/creativeGroupIds: creative_group_ids +/dfareporting:v2.7/Campaign/creativeGroupIds/creative_group_id: creative_group_id +/dfareporting:v2.7/Campaign/creativeOptimizationConfiguration: creative_optimization_configuration +/dfareporting:v2.7/Campaign/defaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/Campaign/endDate: end_date +/dfareporting:v2.7/Campaign/eventTagOverrides: event_tag_overrides +/dfareporting:v2.7/Campaign/eventTagOverrides/event_tag_override: event_tag_override +/dfareporting:v2.7/Campaign/externalId: external_id +/dfareporting:v2.7/Campaign/id: id +/dfareporting:v2.7/Campaign/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Campaign/kind: kind +/dfareporting:v2.7/Campaign/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Campaign/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/Campaign/name: name +/dfareporting:v2.7/Campaign/nielsenOcrEnabled: nielsen_ocr_enabled +/dfareporting:v2.7/Campaign/startDate: start_date +/dfareporting:v2.7/Campaign/subaccountId: subaccount_id +/dfareporting:v2.7/Campaign/traffickerEmails: trafficker_emails +/dfareporting:v2.7/Campaign/traffickerEmails/trafficker_email: trafficker_email +/dfareporting:v2.7/CampaignCreativeAssociation: campaign_creative_association +/dfareporting:v2.7/CampaignCreativeAssociation/creativeId: creative_id +/dfareporting:v2.7/CampaignCreativeAssociation/kind: kind +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse: campaign_creative_associations_list_response +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations: campaign_creative_associations +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations/campaign_creative_association: campaign_creative_association +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/kind: kind +/dfareporting:v2.7/CampaignCreativeAssociationsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CampaignsListResponse: campaigns_list_response +/dfareporting:v2.7/CampaignsListResponse/campaigns: campaigns +/dfareporting:v2.7/CampaignsListResponse/campaigns/campaign: campaign +/dfareporting:v2.7/CampaignsListResponse/kind: kind +/dfareporting:v2.7/CampaignsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ChangeLog: change_log +/dfareporting:v2.7/ChangeLog/accountId: account_id +/dfareporting:v2.7/ChangeLog/action: action +/dfareporting:v2.7/ChangeLog/changeTime: change_time +/dfareporting:v2.7/ChangeLog/fieldName: field_name +/dfareporting:v2.7/ChangeLog/id: id +/dfareporting:v2.7/ChangeLog/kind: kind +/dfareporting:v2.7/ChangeLog/newValue: new_value +/dfareporting:v2.7/ChangeLog/objectId: object_id_prop +/dfareporting:v2.7/ChangeLog/objectType: object_type +/dfareporting:v2.7/ChangeLog/oldValue: old_value +/dfareporting:v2.7/ChangeLog/subaccountId: subaccount_id +/dfareporting:v2.7/ChangeLog/transactionId: transaction_id +/dfareporting:v2.7/ChangeLog/userProfileId: user_profile_id +/dfareporting:v2.7/ChangeLog/userProfileName: user_profile_name +/dfareporting:v2.7/ChangeLogsListResponse: change_logs_list_response +/dfareporting:v2.7/ChangeLogsListResponse/changeLogs: change_logs +/dfareporting:v2.7/ChangeLogsListResponse/changeLogs/change_log: change_log +/dfareporting:v2.7/ChangeLogsListResponse/kind: kind +/dfareporting:v2.7/ChangeLogsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CitiesListResponse: cities_list_response +/dfareporting:v2.7/CitiesListResponse/cities: cities +/dfareporting:v2.7/CitiesListResponse/cities/city: city +/dfareporting:v2.7/CitiesListResponse/kind: kind +/dfareporting:v2.7/City: city +/dfareporting:v2.7/City/countryCode: country_code +/dfareporting:v2.7/City/countryDartId: country_dart_id +/dfareporting:v2.7/City/dartId: dart_id +/dfareporting:v2.7/City/kind: kind +/dfareporting:v2.7/City/metroCode: metro_code +/dfareporting:v2.7/City/metroDmaId: metro_dma_id +/dfareporting:v2.7/City/name: name +/dfareporting:v2.7/City/regionCode: region_code +/dfareporting:v2.7/City/regionDartId: region_dart_id +/dfareporting:v2.7/ClickTag: click_tag +/dfareporting:v2.7/ClickTag/eventName: event_name +/dfareporting:v2.7/ClickTag/name: name +/dfareporting:v2.7/ClickTag/value: value +/dfareporting:v2.7/ClickThroughUrl: click_through_url +/dfareporting:v2.7/ClickThroughUrl/computedClickThroughUrl: computed_click_through_url +/dfareporting:v2.7/ClickThroughUrl/customClickThroughUrl: custom_click_through_url +/dfareporting:v2.7/ClickThroughUrl/defaultLandingPage: default_landing_page +/dfareporting:v2.7/ClickThroughUrl/landingPageId: landing_page_id +/dfareporting:v2.7/ClickThroughUrlSuffixProperties: click_through_url_suffix_properties +/dfareporting:v2.7/ClickThroughUrlSuffixProperties/clickThroughUrlSuffix: click_through_url_suffix +/dfareporting:v2.7/ClickThroughUrlSuffixProperties/overrideInheritedSuffix: override_inherited_suffix +/dfareporting:v2.7/CompanionClickThroughOverride: companion_click_through_override +/dfareporting:v2.7/CompanionClickThroughOverride/clickThroughUrl: click_through_url +/dfareporting:v2.7/CompanionClickThroughOverride/creativeId: creative_id +/dfareporting:v2.7/CompanionSetting: companion_setting +/dfareporting:v2.7/CompanionSetting/companionsDisabled: companions_disabled +/dfareporting:v2.7/CompanionSetting/enabledSizes: enabled_sizes +/dfareporting:v2.7/CompanionSetting/enabledSizes/enabled_size: enabled_size +/dfareporting:v2.7/CompanionSetting/imageOnly: image_only +/dfareporting:v2.7/CompanionSetting/kind: kind +/dfareporting:v2.7/CompatibleFields: compatible_fields +/dfareporting:v2.7/CompatibleFields/crossDimensionReachReportCompatibleFields: cross_dimension_reach_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/floodlightReportCompatibleFields: floodlight_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/kind: kind +/dfareporting:v2.7/CompatibleFields/pathToConversionReportCompatibleFields: path_to_conversion_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/reachReportCompatibleFields: reach_report_compatible_fields +/dfareporting:v2.7/CompatibleFields/reportCompatibleFields: report_compatible_fields +/dfareporting:v2.7/ConnectionType: connection_type +/dfareporting:v2.7/ConnectionType/id: id +/dfareporting:v2.7/ConnectionType/kind: kind +/dfareporting:v2.7/ConnectionType/name: name +/dfareporting:v2.7/ConnectionTypesListResponse: connection_types_list_response +/dfareporting:v2.7/ConnectionTypesListResponse/connectionTypes: connection_types +/dfareporting:v2.7/ConnectionTypesListResponse/connectionTypes/connection_type: connection_type +/dfareporting:v2.7/ConnectionTypesListResponse/kind: kind +/dfareporting:v2.7/ContentCategoriesListResponse: content_categories_list_response +/dfareporting:v2.7/ContentCategoriesListResponse/contentCategories: content_categories +/dfareporting:v2.7/ContentCategoriesListResponse/contentCategories/content_category: content_category +/dfareporting:v2.7/ContentCategoriesListResponse/kind: kind +/dfareporting:v2.7/ContentCategoriesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ContentCategory: content_category +/dfareporting:v2.7/ContentCategory/accountId: account_id +/dfareporting:v2.7/ContentCategory/id: id +/dfareporting:v2.7/ContentCategory/kind: kind +/dfareporting:v2.7/ContentCategory/name: name +/dfareporting:v2.7/Conversion: conversion +/dfareporting:v2.7/Conversion/childDirectedTreatment: child_directed_treatment +/dfareporting:v2.7/Conversion/customVariables: custom_variables +/dfareporting:v2.7/Conversion/customVariables/custom_variable: custom_variable +/dfareporting:v2.7/Conversion/encryptedUserId: encrypted_user_id +/dfareporting:v2.7/Conversion/encryptedUserIdCandidates: encrypted_user_id_candidates +/dfareporting:v2.7/Conversion/encryptedUserIdCandidates/encrypted_user_id_candidate: encrypted_user_id_candidate +/dfareporting:v2.7/Conversion/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/Conversion/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/Conversion/kind: kind +/dfareporting:v2.7/Conversion/limitAdTracking: limit_ad_tracking +/dfareporting:v2.7/Conversion/mobileDeviceId: mobile_device_id +/dfareporting:v2.7/Conversion/ordinal: ordinal +/dfareporting:v2.7/Conversion/quantity: quantity +/dfareporting:v2.7/Conversion/timestampMicros: timestamp_micros +/dfareporting:v2.7/Conversion/value: value +/dfareporting:v2.7/ConversionError: conversion_error +/dfareporting:v2.7/ConversionError/code: code +/dfareporting:v2.7/ConversionError/kind: kind +/dfareporting:v2.7/ConversionError/message: message +/dfareporting:v2.7/ConversionStatus: conversion_status +/dfareporting:v2.7/ConversionStatus/conversion: conversion +/dfareporting:v2.7/ConversionStatus/errors: errors +/dfareporting:v2.7/ConversionStatus/errors/error: error +/dfareporting:v2.7/ConversionStatus/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertRequest: conversions_batch_insert_request +/dfareporting:v2.7/ConversionsBatchInsertRequest/conversions: conversions +/dfareporting:v2.7/ConversionsBatchInsertRequest/conversions/conversion: conversion +/dfareporting:v2.7/ConversionsBatchInsertRequest/encryptionInfo: encryption_info +/dfareporting:v2.7/ConversionsBatchInsertRequest/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertResponse: conversions_batch_insert_response +/dfareporting:v2.7/ConversionsBatchInsertResponse/hasFailures: has_failures +/dfareporting:v2.7/ConversionsBatchInsertResponse/kind: kind +/dfareporting:v2.7/ConversionsBatchInsertResponse/status: status +/dfareporting:v2.7/ConversionsBatchInsertResponse/status/status: status +/dfareporting:v2.7/CountriesListResponse: countries_list_response +/dfareporting:v2.7/CountriesListResponse/countries: countries +/dfareporting:v2.7/CountriesListResponse/countries/country: country +/dfareporting:v2.7/CountriesListResponse/kind: kind +/dfareporting:v2.7/Country: country +/dfareporting:v2.7/Country/countryCode: country_code +/dfareporting:v2.7/Country/dartId: dart_id +/dfareporting:v2.7/Country/kind: kind +/dfareporting:v2.7/Country/name: name +/dfareporting:v2.7/Country/sslEnabled: ssl_enabled +/dfareporting:v2.7/Creative: creative +/dfareporting:v2.7/Creative/accountId: account_id +/dfareporting:v2.7/Creative/active: active +/dfareporting:v2.7/Creative/adParameters: ad_parameters +/dfareporting:v2.7/Creative/adTagKeys: ad_tag_keys +/dfareporting:v2.7/Creative/adTagKeys/ad_tag_key: ad_tag_key +/dfareporting:v2.7/Creative/advertiserId: advertiser_id +/dfareporting:v2.7/Creative/allowScriptAccess: allow_script_access +/dfareporting:v2.7/Creative/archived: archived +/dfareporting:v2.7/Creative/artworkType: artwork_type +/dfareporting:v2.7/Creative/authoringSource: authoring_source +/dfareporting:v2.7/Creative/authoringTool: authoring_tool +/dfareporting:v2.7/Creative/auto_advance_images: auto_advance_images +/dfareporting:v2.7/Creative/backgroundColor: background_color +/dfareporting:v2.7/Creative/backupImageClickThroughUrl: backup_image_click_through_url +/dfareporting:v2.7/Creative/backupImageFeatures: backup_image_features +/dfareporting:v2.7/Creative/backupImageFeatures/backup_image_feature: backup_image_feature +/dfareporting:v2.7/Creative/backupImageReportingLabel: backup_image_reporting_label +/dfareporting:v2.7/Creative/backupImageTargetWindow: backup_image_target_window +/dfareporting:v2.7/Creative/clickTags: click_tags +/dfareporting:v2.7/Creative/clickTags/click_tag: click_tag +/dfareporting:v2.7/Creative/commercialId: commercial_id +/dfareporting:v2.7/Creative/companionCreatives: companion_creatives +/dfareporting:v2.7/Creative/companionCreatives/companion_creative: companion_creative +/dfareporting:v2.7/Creative/compatibility: compatibility +/dfareporting:v2.7/Creative/compatibility/compatibility: compatibility +/dfareporting:v2.7/Creative/convertFlashToHtml5: convert_flash_to_html5 +/dfareporting:v2.7/Creative/counterCustomEvents: counter_custom_events +/dfareporting:v2.7/Creative/counterCustomEvents/counter_custom_event: counter_custom_event +/dfareporting:v2.7/Creative/creativeAssetSelection: creative_asset_selection +/dfareporting:v2.7/Creative/creativeAssets: creative_assets +/dfareporting:v2.7/Creative/creativeAssets/creative_asset: creative_asset +/dfareporting:v2.7/Creative/creativeFieldAssignments: creative_field_assignments +/dfareporting:v2.7/Creative/creativeFieldAssignments/creative_field_assignment: creative_field_assignment +/dfareporting:v2.7/Creative/customKeyValues: custom_key_values +/dfareporting:v2.7/Creative/customKeyValues/custom_key_value: custom_key_value +/dfareporting:v2.7/Creative/dynamicAssetSelection: dynamic_asset_selection +/dfareporting:v2.7/Creative/exitCustomEvents: exit_custom_events +/dfareporting:v2.7/Creative/exitCustomEvents/exit_custom_event: exit_custom_event +/dfareporting:v2.7/Creative/fsCommand: fs_command +/dfareporting:v2.7/Creative/htmlCode: html_code +/dfareporting:v2.7/Creative/htmlCodeLocked: html_code_locked +/dfareporting:v2.7/Creative/id: id +/dfareporting:v2.7/Creative/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Creative/kind: kind +/dfareporting:v2.7/Creative/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Creative/latestTraffickedCreativeId: latest_trafficked_creative_id +/dfareporting:v2.7/Creative/name: name +/dfareporting:v2.7/Creative/overrideCss: override_css +/dfareporting:v2.7/Creative/progressOffset: progress_offset +/dfareporting:v2.7/Creative/redirectUrl: redirect_url +/dfareporting:v2.7/Creative/renderingId: rendering_id +/dfareporting:v2.7/Creative/renderingIdDimensionValue: rendering_id_dimension_value +/dfareporting:v2.7/Creative/requiredFlashPluginVersion: required_flash_plugin_version +/dfareporting:v2.7/Creative/requiredFlashVersion: required_flash_version +/dfareporting:v2.7/Creative/size: size +/dfareporting:v2.7/Creative/skipOffset: skip_offset +/dfareporting:v2.7/Creative/skippable: skippable +/dfareporting:v2.7/Creative/sslCompliant: ssl_compliant +/dfareporting:v2.7/Creative/sslOverride: ssl_override +/dfareporting:v2.7/Creative/studioAdvertiserId: studio_advertiser_id +/dfareporting:v2.7/Creative/studioCreativeId: studio_creative_id +/dfareporting:v2.7/Creative/studioTraffickedCreativeId: studio_trafficked_creative_id +/dfareporting:v2.7/Creative/subaccountId: subaccount_id +/dfareporting:v2.7/Creative/thirdPartyBackupImageImpressionsUrl: third_party_backup_image_impressions_url +/dfareporting:v2.7/Creative/thirdPartyRichMediaImpressionsUrl: third_party_rich_media_impressions_url +/dfareporting:v2.7/Creative/thirdPartyUrls: third_party_urls +/dfareporting:v2.7/Creative/thirdPartyUrls/third_party_url: third_party_url +/dfareporting:v2.7/Creative/timerCustomEvents: timer_custom_events +/dfareporting:v2.7/Creative/timerCustomEvents/timer_custom_event: timer_custom_event +/dfareporting:v2.7/Creative/totalFileSize: total_file_size +/dfareporting:v2.7/Creative/type: type +/dfareporting:v2.7/Creative/version: version +/dfareporting:v2.7/Creative/videoDescription: video_description +/dfareporting:v2.7/Creative/videoDuration: video_duration +/dfareporting:v2.7/CreativeAsset: creative_asset +/dfareporting:v2.7/CreativeAsset/actionScript3: action_script3 +/dfareporting:v2.7/CreativeAsset/active: active +/dfareporting:v2.7/CreativeAsset/alignment: alignment +/dfareporting:v2.7/CreativeAsset/artworkType: artwork_type +/dfareporting:v2.7/CreativeAsset/assetIdentifier: asset_identifier +/dfareporting:v2.7/CreativeAsset/backupImageExit: backup_image_exit +/dfareporting:v2.7/CreativeAsset/bitRate: bit_rate +/dfareporting:v2.7/CreativeAsset/childAssetType: child_asset_type +/dfareporting:v2.7/CreativeAsset/collapsedSize: collapsed_size +/dfareporting:v2.7/CreativeAsset/companionCreativeIds: companion_creative_ids +/dfareporting:v2.7/CreativeAsset/companionCreativeIds/companion_creative_id: companion_creative_id +/dfareporting:v2.7/CreativeAsset/customStartTimeValue: custom_start_time_value +/dfareporting:v2.7/CreativeAsset/detectedFeatures: detected_features +/dfareporting:v2.7/CreativeAsset/detectedFeatures/detected_feature: detected_feature +/dfareporting:v2.7/CreativeAsset/displayType: display_type +/dfareporting:v2.7/CreativeAsset/duration: duration +/dfareporting:v2.7/CreativeAsset/durationType: duration_type +/dfareporting:v2.7/CreativeAsset/expandedDimension: expanded_dimension +/dfareporting:v2.7/CreativeAsset/fileSize: file_size +/dfareporting:v2.7/CreativeAsset/flashVersion: flash_version +/dfareporting:v2.7/CreativeAsset/hideFlashObjects: hide_flash_objects +/dfareporting:v2.7/CreativeAsset/hideSelectionBoxes: hide_selection_boxes +/dfareporting:v2.7/CreativeAsset/horizontallyLocked: horizontally_locked +/dfareporting:v2.7/CreativeAsset/id: id +/dfareporting:v2.7/CreativeAsset/idDimensionValue: id_dimension_value +/dfareporting:v2.7/CreativeAsset/mimeType: mime_type +/dfareporting:v2.7/CreativeAsset/offset: offset +/dfareporting:v2.7/CreativeAsset/originalBackup: original_backup +/dfareporting:v2.7/CreativeAsset/position: position +/dfareporting:v2.7/CreativeAsset/positionLeftUnit: position_left_unit +/dfareporting:v2.7/CreativeAsset/positionTopUnit: position_top_unit +/dfareporting:v2.7/CreativeAsset/progressiveServingUrl: progressive_serving_url +/dfareporting:v2.7/CreativeAsset/pushdown: pushdown +/dfareporting:v2.7/CreativeAsset/pushdownDuration: pushdown_duration +/dfareporting:v2.7/CreativeAsset/role: role +/dfareporting:v2.7/CreativeAsset/size: size +/dfareporting:v2.7/CreativeAsset/sslCompliant: ssl_compliant +/dfareporting:v2.7/CreativeAsset/startTimeType: start_time_type +/dfareporting:v2.7/CreativeAsset/streamingServingUrl: streaming_serving_url +/dfareporting:v2.7/CreativeAsset/transparency: transparency +/dfareporting:v2.7/CreativeAsset/verticallyLocked: vertically_locked +/dfareporting:v2.7/CreativeAsset/videoDuration: video_duration +/dfareporting:v2.7/CreativeAsset/windowMode: window_mode +/dfareporting:v2.7/CreativeAsset/zIndex: z_index +/dfareporting:v2.7/CreativeAsset/zipFilename: zip_filename +/dfareporting:v2.7/CreativeAsset/zipFilesize: zip_filesize +/dfareporting:v2.7/CreativeAssetId: creative_asset_id +/dfareporting:v2.7/CreativeAssetId/name: name +/dfareporting:v2.7/CreativeAssetId/type: type +/dfareporting:v2.7/CreativeAssetMetadata: creative_asset_metadata +/dfareporting:v2.7/CreativeAssetMetadata/assetIdentifier: asset_identifier +/dfareporting:v2.7/CreativeAssetMetadata/clickTags: click_tags +/dfareporting:v2.7/CreativeAssetMetadata/clickTags/click_tag: click_tag +/dfareporting:v2.7/CreativeAssetMetadata/detectedFeatures: detected_features +/dfareporting:v2.7/CreativeAssetMetadata/detectedFeatures/detected_feature: detected_feature +/dfareporting:v2.7/CreativeAssetMetadata/id: id +/dfareporting:v2.7/CreativeAssetMetadata/idDimensionValue: id_dimension_value +/dfareporting:v2.7/CreativeAssetMetadata/kind: kind +/dfareporting:v2.7/CreativeAssetMetadata/warnedValidationRules: warned_validation_rules +/dfareporting:v2.7/CreativeAssetMetadata/warnedValidationRules/warned_validation_rule: warned_validation_rule +/dfareporting:v2.7/CreativeAssetSelection: creative_asset_selection +/dfareporting:v2.7/CreativeAssetSelection/defaultAssetId: default_asset_id +/dfareporting:v2.7/CreativeAssetSelection/rules: rules +/dfareporting:v2.7/CreativeAssetSelection/rules/rule: rule +/dfareporting:v2.7/CreativeAssignment: creative_assignment +/dfareporting:v2.7/CreativeAssignment/active: active +/dfareporting:v2.7/CreativeAssignment/applyEventTags: apply_event_tags +/dfareporting:v2.7/CreativeAssignment/clickThroughUrl: click_through_url +/dfareporting:v2.7/CreativeAssignment/companionCreativeOverrides: companion_creative_overrides +/dfareporting:v2.7/CreativeAssignment/companionCreativeOverrides/companion_creative_override: companion_creative_override +/dfareporting:v2.7/CreativeAssignment/creativeGroupAssignments: creative_group_assignments +/dfareporting:v2.7/CreativeAssignment/creativeGroupAssignments/creative_group_assignment: creative_group_assignment +/dfareporting:v2.7/CreativeAssignment/creativeId: creative_id +/dfareporting:v2.7/CreativeAssignment/creativeIdDimensionValue: creative_id_dimension_value +/dfareporting:v2.7/CreativeAssignment/endTime: end_time +/dfareporting:v2.7/CreativeAssignment/richMediaExitOverrides: rich_media_exit_overrides +/dfareporting:v2.7/CreativeAssignment/richMediaExitOverrides/rich_media_exit_override: rich_media_exit_override +/dfareporting:v2.7/CreativeAssignment/sequence: sequence +/dfareporting:v2.7/CreativeAssignment/sslCompliant: ssl_compliant +/dfareporting:v2.7/CreativeAssignment/startTime: start_time +/dfareporting:v2.7/CreativeAssignment/weight: weight +/dfareporting:v2.7/CreativeCustomEvent: creative_custom_event +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventId: advertiser_custom_event_id +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventName: advertiser_custom_event_name +/dfareporting:v2.7/CreativeCustomEvent/advertiserCustomEventType: advertiser_custom_event_type +/dfareporting:v2.7/CreativeCustomEvent/artworkLabel: artwork_label +/dfareporting:v2.7/CreativeCustomEvent/artworkType: artwork_type +/dfareporting:v2.7/CreativeCustomEvent/exitUrl: exit_url +/dfareporting:v2.7/CreativeCustomEvent/id: id +/dfareporting:v2.7/CreativeCustomEvent/popupWindowProperties: popup_window_properties +/dfareporting:v2.7/CreativeCustomEvent/targetType: target_type +/dfareporting:v2.7/CreativeCustomEvent/videoReportingId: video_reporting_id +/dfareporting:v2.7/CreativeField: creative_field +/dfareporting:v2.7/CreativeField/accountId: account_id +/dfareporting:v2.7/CreativeField/advertiserId: advertiser_id +/dfareporting:v2.7/CreativeField/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/CreativeField/id: id +/dfareporting:v2.7/CreativeField/kind: kind +/dfareporting:v2.7/CreativeField/name: name +/dfareporting:v2.7/CreativeField/subaccountId: subaccount_id +/dfareporting:v2.7/CreativeFieldAssignment: creative_field_assignment +/dfareporting:v2.7/CreativeFieldAssignment/creativeFieldId: creative_field_id +/dfareporting:v2.7/CreativeFieldAssignment/creativeFieldValueId: creative_field_value_id +/dfareporting:v2.7/CreativeFieldValue: creative_field_value +/dfareporting:v2.7/CreativeFieldValue/id: id +/dfareporting:v2.7/CreativeFieldValue/kind: kind +/dfareporting:v2.7/CreativeFieldValue/value: value +/dfareporting:v2.7/CreativeFieldValuesListResponse: creative_field_values_list_response +/dfareporting:v2.7/CreativeFieldValuesListResponse/creativeFieldValues: creative_field_values +/dfareporting:v2.7/CreativeFieldValuesListResponse/creativeFieldValues/creative_field_value: creative_field_value +/dfareporting:v2.7/CreativeFieldValuesListResponse/kind: kind +/dfareporting:v2.7/CreativeFieldValuesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeFieldsListResponse: creative_fields_list_response +/dfareporting:v2.7/CreativeFieldsListResponse/creativeFields: creative_fields +/dfareporting:v2.7/CreativeFieldsListResponse/creativeFields/creative_field: creative_field +/dfareporting:v2.7/CreativeFieldsListResponse/kind: kind +/dfareporting:v2.7/CreativeFieldsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeGroup: creative_group +/dfareporting:v2.7/CreativeGroup/accountId: account_id +/dfareporting:v2.7/CreativeGroup/advertiserId: advertiser_id +/dfareporting:v2.7/CreativeGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/CreativeGroup/groupNumber: group_number +/dfareporting:v2.7/CreativeGroup/id: id +/dfareporting:v2.7/CreativeGroup/kind: kind +/dfareporting:v2.7/CreativeGroup/name: name +/dfareporting:v2.7/CreativeGroup/subaccountId: subaccount_id +/dfareporting:v2.7/CreativeGroupAssignment: creative_group_assignment +/dfareporting:v2.7/CreativeGroupAssignment/creativeGroupId: creative_group_id +/dfareporting:v2.7/CreativeGroupAssignment/creativeGroupNumber: creative_group_number +/dfareporting:v2.7/CreativeGroupsListResponse: creative_groups_list_response +/dfareporting:v2.7/CreativeGroupsListResponse/creativeGroups: creative_groups +/dfareporting:v2.7/CreativeGroupsListResponse/creativeGroups/creative_group: creative_group +/dfareporting:v2.7/CreativeGroupsListResponse/kind: kind +/dfareporting:v2.7/CreativeGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CreativeOptimizationConfiguration: creative_optimization_configuration +/dfareporting:v2.7/CreativeOptimizationConfiguration/id: id +/dfareporting:v2.7/CreativeOptimizationConfiguration/name: name +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationActivitys: optimization_activitys +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationActivitys/optimization_activity: optimization_activity +/dfareporting:v2.7/CreativeOptimizationConfiguration/optimizationModel: optimization_model +/dfareporting:v2.7/CreativeRotation: creative_rotation +/dfareporting:v2.7/CreativeRotation/creativeAssignments: creative_assignments +/dfareporting:v2.7/CreativeRotation/creativeAssignments/creative_assignment: creative_assignment +/dfareporting:v2.7/CreativeRotation/creativeOptimizationConfigurationId: creative_optimization_configuration_id +/dfareporting:v2.7/CreativeRotation/type: type +/dfareporting:v2.7/CreativeRotation/weightCalculationStrategy: weight_calculation_strategy +/dfareporting:v2.7/CreativeSettings: creative_settings +/dfareporting:v2.7/CreativeSettings/iFrameFooter: i_frame_footer +/dfareporting:v2.7/CreativeSettings/iFrameHeader: i_frame_header +/dfareporting:v2.7/CreativesListResponse: creatives_list_response +/dfareporting:v2.7/CreativesListResponse/creatives: creatives +/dfareporting:v2.7/CreativesListResponse/creatives/creative: creative +/dfareporting:v2.7/CreativesListResponse/kind: kind +/dfareporting:v2.7/CreativesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields: cross_dimension_reach_report_compatible_fields +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/breakdown: breakdown +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/breakdown/breakdown: breakdown +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/kind: kind +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/overlapMetrics: overlap_metrics +/dfareporting:v2.7/CrossDimensionReachReportCompatibleFields/overlapMetrics/overlap_metric: overlap_metric +/dfareporting:v2.7/CustomFloodlightVariable: custom_floodlight_variable +/dfareporting:v2.7/CustomFloodlightVariable/kind: kind +/dfareporting:v2.7/CustomFloodlightVariable/type: type +/dfareporting:v2.7/CustomFloodlightVariable/value: value +/dfareporting:v2.7/CustomRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/CustomRichMediaEvents/filteredEventIds: filtered_event_ids +/dfareporting:v2.7/CustomRichMediaEvents/filteredEventIds/filtered_event_id: filtered_event_id +/dfareporting:v2.7/CustomRichMediaEvents/kind: kind +/dfareporting:v2.7/DateRange: date_range +/dfareporting:v2.7/DateRange/endDate: end_date +/dfareporting:v2.7/DateRange/kind: kind +/dfareporting:v2.7/DateRange/relativeDateRange: relative_date_range +/dfareporting:v2.7/DateRange/startDate: start_date +/dfareporting:v2.7/DayPartTargeting: day_part_targeting +/dfareporting:v2.7/DayPartTargeting/daysOfWeek: days_of_week +/dfareporting:v2.7/DayPartTargeting/daysOfWeek/days_of_week: days_of_week +/dfareporting:v2.7/DayPartTargeting/hoursOfDay: hours_of_day +/dfareporting:v2.7/DayPartTargeting/hoursOfDay/hours_of_day: hours_of_day +/dfareporting:v2.7/DayPartTargeting/userLocalTime: user_local_time +/dfareporting:v2.7/DefaultClickThroughEventTagProperties: default_click_through_event_tag_properties +/dfareporting:v2.7/DefaultClickThroughEventTagProperties/defaultClickThroughEventTagId: default_click_through_event_tag_id +/dfareporting:v2.7/DefaultClickThroughEventTagProperties/overrideInheritedEventTag: override_inherited_event_tag +/dfareporting:v2.7/DeliverySchedule: delivery_schedule +/dfareporting:v2.7/DeliverySchedule/frequencyCap: frequency_cap +/dfareporting:v2.7/DeliverySchedule/hardCutoff: hard_cutoff +/dfareporting:v2.7/DeliverySchedule/impressionRatio: impression_ratio +/dfareporting:v2.7/DeliverySchedule/priority: priority +/dfareporting:v2.7/DfpSettings: dfp_settings +/dfareporting:v2.7/DfpSettings/dfp_network_code: dfp_network_code +/dfareporting:v2.7/DfpSettings/dfp_network_name: dfp_network_name +/dfareporting:v2.7/DfpSettings/programmaticPlacementAccepted: programmatic_placement_accepted +/dfareporting:v2.7/DfpSettings/pubPaidPlacementAccepted: pub_paid_placement_accepted +/dfareporting:v2.7/DfpSettings/publisherPortalOnly: publisher_portal_only +/dfareporting:v2.7/Dimension: dimension +/dfareporting:v2.7/Dimension/kind: kind +/dfareporting:v2.7/Dimension/name: name +/dfareporting:v2.7/DimensionFilter: dimension_filter +/dfareporting:v2.7/DimensionFilter/dimensionName: dimension_name +/dfareporting:v2.7/DimensionFilter/kind: kind +/dfareporting:v2.7/DimensionFilter/value: value +/dfareporting:v2.7/DimensionValue: dimension_value +/dfareporting:v2.7/DimensionValue/dimensionName: dimension_name +/dfareporting:v2.7/DimensionValue/etag: etag +/dfareporting:v2.7/DimensionValue/id: id +/dfareporting:v2.7/DimensionValue/kind: kind +/dfareporting:v2.7/DimensionValue/matchType: match_type +/dfareporting:v2.7/DimensionValue/value: value +/dfareporting:v2.7/DimensionValueList: dimension_value_list +/dfareporting:v2.7/DimensionValueList/etag: etag +/dfareporting:v2.7/DimensionValueList/items: items +/dfareporting:v2.7/DimensionValueList/items/item: item +/dfareporting:v2.7/DimensionValueList/kind: kind +/dfareporting:v2.7/DimensionValueList/nextPageToken: next_page_token +/dfareporting:v2.7/DimensionValueRequest: dimension_value_request +/dfareporting:v2.7/DimensionValueRequest/dimensionName: dimension_name +/dfareporting:v2.7/DimensionValueRequest/endDate: end_date +/dfareporting:v2.7/DimensionValueRequest/filters: filters +/dfareporting:v2.7/DimensionValueRequest/filters/filter: filter +/dfareporting:v2.7/DimensionValueRequest/kind: kind +/dfareporting:v2.7/DimensionValueRequest/startDate: start_date +/dfareporting:v2.7/DirectorySite: directory_site +/dfareporting:v2.7/DirectorySite/active: active +/dfareporting:v2.7/DirectorySite/contactAssignments: contact_assignments +/dfareporting:v2.7/DirectorySite/contactAssignments/contact_assignment: contact_assignment +/dfareporting:v2.7/DirectorySite/countryId: country_id +/dfareporting:v2.7/DirectorySite/currencyId: currency_id +/dfareporting:v2.7/DirectorySite/description: description +/dfareporting:v2.7/DirectorySite/id: id +/dfareporting:v2.7/DirectorySite/idDimensionValue: id_dimension_value +/dfareporting:v2.7/DirectorySite/inpageTagFormats: inpage_tag_formats +/dfareporting:v2.7/DirectorySite/inpageTagFormats/inpage_tag_format: inpage_tag_format +/dfareporting:v2.7/DirectorySite/interstitialTagFormats: interstitial_tag_formats +/dfareporting:v2.7/DirectorySite/interstitialTagFormats/interstitial_tag_format: interstitial_tag_format +/dfareporting:v2.7/DirectorySite/kind: kind +/dfareporting:v2.7/DirectorySite/name: name +/dfareporting:v2.7/DirectorySite/parentId: parent_id +/dfareporting:v2.7/DirectorySite/settings: settings +/dfareporting:v2.7/DirectorySite/url: url +/dfareporting:v2.7/DirectorySiteContact: directory_site_contact +/dfareporting:v2.7/DirectorySiteContact/address: address +/dfareporting:v2.7/DirectorySiteContact/email: email +/dfareporting:v2.7/DirectorySiteContact/firstName: first_name +/dfareporting:v2.7/DirectorySiteContact/id: id +/dfareporting:v2.7/DirectorySiteContact/kind: kind +/dfareporting:v2.7/DirectorySiteContact/lastName: last_name +/dfareporting:v2.7/DirectorySiteContact/phone: phone +/dfareporting:v2.7/DirectorySiteContact/role: role +/dfareporting:v2.7/DirectorySiteContact/title: title +/dfareporting:v2.7/DirectorySiteContact/type: type +/dfareporting:v2.7/DirectorySiteContactAssignment: directory_site_contact_assignment +/dfareporting:v2.7/DirectorySiteContactAssignment/contactId: contact_id +/dfareporting:v2.7/DirectorySiteContactAssignment/visibility: visibility +/dfareporting:v2.7/DirectorySiteContactsListResponse: directory_site_contacts_list_response +/dfareporting:v2.7/DirectorySiteContactsListResponse/directorySiteContacts: directory_site_contacts +/dfareporting:v2.7/DirectorySiteContactsListResponse/directorySiteContacts/directory_site_contact: directory_site_contact +/dfareporting:v2.7/DirectorySiteContactsListResponse/kind: kind +/dfareporting:v2.7/DirectorySiteContactsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/DirectorySiteSettings: directory_site_settings +/dfareporting:v2.7/DirectorySiteSettings/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/DirectorySiteSettings/dfp_settings: dfp_settings +/dfareporting:v2.7/DirectorySiteSettings/instream_video_placement_accepted: instream_video_placement_accepted +/dfareporting:v2.7/DirectorySiteSettings/interstitialPlacementAccepted: interstitial_placement_accepted +/dfareporting:v2.7/DirectorySiteSettings/nielsenOcrOptOut: nielsen_ocr_opt_out +/dfareporting:v2.7/DirectorySiteSettings/verificationTagOptOut: verification_tag_opt_out +/dfareporting:v2.7/DirectorySiteSettings/videoActiveViewOptOut: video_active_view_opt_out +/dfareporting:v2.7/DirectorySitesListResponse: directory_sites_list_response +/dfareporting:v2.7/DirectorySitesListResponse/directorySites: directory_sites +/dfareporting:v2.7/DirectorySitesListResponse/directorySites/directory_site: directory_site +/dfareporting:v2.7/DirectorySitesListResponse/kind: kind +/dfareporting:v2.7/DirectorySitesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/DynamicTargetingKey: dynamic_targeting_key +/dfareporting:v2.7/DynamicTargetingKey/kind: kind +/dfareporting:v2.7/DynamicTargetingKey/name: name +/dfareporting:v2.7/DynamicTargetingKey/objectId: object_id_prop +/dfareporting:v2.7/DynamicTargetingKey/objectType: object_type +/dfareporting:v2.7/DynamicTargetingKeysListResponse: dynamic_targeting_keys_list_response +/dfareporting:v2.7/DynamicTargetingKeysListResponse/dynamicTargetingKeys: dynamic_targeting_keys +/dfareporting:v2.7/DynamicTargetingKeysListResponse/dynamicTargetingKeys/dynamic_targeting_key: dynamic_targeting_key +/dfareporting:v2.7/DynamicTargetingKeysListResponse/kind: kind +/dfareporting:v2.7/EncryptionInfo: encryption_info +/dfareporting:v2.7/EncryptionInfo/encryptionEntityId: encryption_entity_id +/dfareporting:v2.7/EncryptionInfo/encryptionEntityType: encryption_entity_type +/dfareporting:v2.7/EncryptionInfo/encryptionSource: encryption_source +/dfareporting:v2.7/EncryptionInfo/kind: kind +/dfareporting:v2.7/EventTag: event_tag +/dfareporting:v2.7/EventTag/accountId: account_id +/dfareporting:v2.7/EventTag/advertiserId: advertiser_id +/dfareporting:v2.7/EventTag/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/EventTag/campaignId: campaign_id +/dfareporting:v2.7/EventTag/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/EventTag/enabledByDefault: enabled_by_default +/dfareporting:v2.7/EventTag/excludeFromAdxRequests: exclude_from_adx_requests +/dfareporting:v2.7/EventTag/id: id +/dfareporting:v2.7/EventTag/kind: kind +/dfareporting:v2.7/EventTag/name: name +/dfareporting:v2.7/EventTag/siteFilterType: site_filter_type +/dfareporting:v2.7/EventTag/siteIds: site_ids +/dfareporting:v2.7/EventTag/siteIds/site_id: site_id +/dfareporting:v2.7/EventTag/sslCompliant: ssl_compliant +/dfareporting:v2.7/EventTag/status: status +/dfareporting:v2.7/EventTag/subaccountId: subaccount_id +/dfareporting:v2.7/EventTag/type: type +/dfareporting:v2.7/EventTag/url: url +/dfareporting:v2.7/EventTag/urlEscapeLevels: url_escape_levels +/dfareporting:v2.7/EventTagOverride: event_tag_override +/dfareporting:v2.7/EventTagOverride/enabled: enabled +/dfareporting:v2.7/EventTagOverride/id: id +/dfareporting:v2.7/EventTagsListResponse: event_tags_list_response +/dfareporting:v2.7/EventTagsListResponse/eventTags: event_tags +/dfareporting:v2.7/EventTagsListResponse/eventTags/event_tag: event_tag +/dfareporting:v2.7/EventTagsListResponse/kind: kind +/dfareporting:v2.7/File: file +/dfareporting:v2.7/File/dateRange: date_range +/dfareporting:v2.7/File/etag: etag +/dfareporting:v2.7/File/fileName: file_name +/dfareporting:v2.7/File/format: format +/dfareporting:v2.7/File/id: id +/dfareporting:v2.7/File/kind: kind +/dfareporting:v2.7/File/lastModifiedTime: last_modified_time +/dfareporting:v2.7/File/reportId: report_id +/dfareporting:v2.7/File/status: status +/dfareporting:v2.7/File/urls: urls +/dfareporting:v2.7/File/urls/apiUrl: api_url +/dfareporting:v2.7/File/urls/browserUrl: browser_url +/dfareporting:v2.7/FileList: file_list +/dfareporting:v2.7/FileList/etag: etag +/dfareporting:v2.7/FileList/items: items +/dfareporting:v2.7/FileList/items/item: item +/dfareporting:v2.7/FileList/kind: kind +/dfareporting:v2.7/FileList/nextPageToken: next_page_token +/dfareporting:v2.7/Flight: flight +/dfareporting:v2.7/Flight/endDate: end_date +/dfareporting:v2.7/Flight/rateOrCost: rate_or_cost +/dfareporting:v2.7/Flight/startDate: start_date +/dfareporting:v2.7/Flight/units: units +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse: floodlight_activities_generate_tag_response +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse/floodlightActivityTag: floodlight_activity_tag +/dfareporting:v2.7/FloodlightActivitiesGenerateTagResponse/kind: kind +/dfareporting:v2.7/FloodlightActivitiesListResponse: floodlight_activities_list_response +/dfareporting:v2.7/FloodlightActivitiesListResponse/floodlightActivities: floodlight_activities +/dfareporting:v2.7/FloodlightActivitiesListResponse/floodlightActivities/floodlight_activity: floodlight_activity +/dfareporting:v2.7/FloodlightActivitiesListResponse/kind: kind +/dfareporting:v2.7/FloodlightActivitiesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/FloodlightActivity: floodlight_activity +/dfareporting:v2.7/FloodlightActivity/accountId: account_id +/dfareporting:v2.7/FloodlightActivity/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightActivity/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightActivity/cacheBustingType: cache_busting_type +/dfareporting:v2.7/FloodlightActivity/countingMethod: counting_method +/dfareporting:v2.7/FloodlightActivity/defaultTags: default_tags +/dfareporting:v2.7/FloodlightActivity/defaultTags/default_tag: default_tag +/dfareporting:v2.7/FloodlightActivity/expectedUrl: expected_url +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupId: floodlight_activity_group_id +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupName: floodlight_activity_group_name +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupTagString: floodlight_activity_group_tag_string +/dfareporting:v2.7/FloodlightActivity/floodlightActivityGroupType: floodlight_activity_group_type +/dfareporting:v2.7/FloodlightActivity/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/FloodlightActivity/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/FloodlightActivity/hidden: hidden +/dfareporting:v2.7/FloodlightActivity/id: id +/dfareporting:v2.7/FloodlightActivity/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightActivity/imageTagEnabled: image_tag_enabled +/dfareporting:v2.7/FloodlightActivity/kind: kind +/dfareporting:v2.7/FloodlightActivity/name: name +/dfareporting:v2.7/FloodlightActivity/notes: notes +/dfareporting:v2.7/FloodlightActivity/publisherTags: publisher_tags +/dfareporting:v2.7/FloodlightActivity/publisherTags/publisher_tag: publisher_tag +/dfareporting:v2.7/FloodlightActivity/secure: secure +/dfareporting:v2.7/FloodlightActivity/sslCompliant: ssl_compliant +/dfareporting:v2.7/FloodlightActivity/sslRequired: ssl_required +/dfareporting:v2.7/FloodlightActivity/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightActivity/tagFormat: tag_format +/dfareporting:v2.7/FloodlightActivity/tagString: tag_string +/dfareporting:v2.7/FloodlightActivity/userDefinedVariableTypes: user_defined_variable_types +/dfareporting:v2.7/FloodlightActivity/userDefinedVariableTypes/user_defined_variable_type: user_defined_variable_type +/dfareporting:v2.7/FloodlightActivityDynamicTag: floodlight_activity_dynamic_tag +/dfareporting:v2.7/FloodlightActivityDynamicTag/id: id +/dfareporting:v2.7/FloodlightActivityDynamicTag/name: name +/dfareporting:v2.7/FloodlightActivityDynamicTag/tag: tag +/dfareporting:v2.7/FloodlightActivityGroup: floodlight_activity_group +/dfareporting:v2.7/FloodlightActivityGroup/accountId: account_id +/dfareporting:v2.7/FloodlightActivityGroup/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightActivityGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/floodlightConfigurationId: floodlight_configuration_id +/dfareporting:v2.7/FloodlightActivityGroup/floodlightConfigurationIdDimensionValue: floodlight_configuration_id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/id: id +/dfareporting:v2.7/FloodlightActivityGroup/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightActivityGroup/kind: kind +/dfareporting:v2.7/FloodlightActivityGroup/name: name +/dfareporting:v2.7/FloodlightActivityGroup/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightActivityGroup/tagString: tag_string +/dfareporting:v2.7/FloodlightActivityGroup/type: type +/dfareporting:v2.7/FloodlightActivityGroupsListResponse: floodlight_activity_groups_list_response +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/floodlightActivityGroups: floodlight_activity_groups +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/floodlightActivityGroups/floodlight_activity_group: floodlight_activity_group +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/kind: kind +/dfareporting:v2.7/FloodlightActivityGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag: floodlight_activity_publisher_dynamic_tag +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/clickThrough: click_through +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/directorySiteId: directory_site_id +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/dynamicTag: dynamic_tag +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/siteId: site_id +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/FloodlightActivityPublisherDynamicTag/viewThrough: view_through +/dfareporting:v2.7/FloodlightConfiguration: floodlight_configuration +/dfareporting:v2.7/FloodlightConfiguration/accountId: account_id +/dfareporting:v2.7/FloodlightConfiguration/advertiserId: advertiser_id +/dfareporting:v2.7/FloodlightConfiguration/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/FloodlightConfiguration/analyticsDataSharingEnabled: analytics_data_sharing_enabled +/dfareporting:v2.7/FloodlightConfiguration/exposureToConversionEnabled: exposure_to_conversion_enabled +/dfareporting:v2.7/FloodlightConfiguration/firstDayOfWeek: first_day_of_week +/dfareporting:v2.7/FloodlightConfiguration/id: id +/dfareporting:v2.7/FloodlightConfiguration/idDimensionValue: id_dimension_value +/dfareporting:v2.7/FloodlightConfiguration/inAppAttributionTrackingEnabled: in_app_attribution_tracking_enabled +/dfareporting:v2.7/FloodlightConfiguration/kind: kind +/dfareporting:v2.7/FloodlightConfiguration/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/FloodlightConfiguration/naturalSearchConversionAttributionOption: natural_search_conversion_attribution_option +/dfareporting:v2.7/FloodlightConfiguration/omnitureSettings: omniture_settings +/dfareporting:v2.7/FloodlightConfiguration/standardVariableTypes: standard_variable_types +/dfareporting:v2.7/FloodlightConfiguration/standardVariableTypes/standard_variable_type: standard_variable_type +/dfareporting:v2.7/FloodlightConfiguration/subaccountId: subaccount_id +/dfareporting:v2.7/FloodlightConfiguration/tagSettings: tag_settings +/dfareporting:v2.7/FloodlightConfiguration/thirdPartyAuthenticationTokens: third_party_authentication_tokens +/dfareporting:v2.7/FloodlightConfiguration/thirdPartyAuthenticationTokens/third_party_authentication_token: third_party_authentication_token +/dfareporting:v2.7/FloodlightConfiguration/userDefinedVariableConfigurations: user_defined_variable_configurations +/dfareporting:v2.7/FloodlightConfiguration/userDefinedVariableConfigurations/user_defined_variable_configuration: user_defined_variable_configuration +/dfareporting:v2.7/FloodlightConfigurationsListResponse: floodlight_configurations_list_response +/dfareporting:v2.7/FloodlightConfigurationsListResponse/floodlightConfigurations: floodlight_configurations +/dfareporting:v2.7/FloodlightConfigurationsListResponse/floodlightConfigurations/floodlight_configuration: floodlight_configuration +/dfareporting:v2.7/FloodlightConfigurationsListResponse/kind: kind +/dfareporting:v2.7/FloodlightReportCompatibleFields: floodlight_report_compatible_fields +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/FloodlightReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/FloodlightReportCompatibleFields/kind: kind +/dfareporting:v2.7/FloodlightReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/FloodlightReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/FrequencyCap: frequency_cap +/dfareporting:v2.7/FrequencyCap/duration: duration +/dfareporting:v2.7/FrequencyCap/impressions: impressions +/dfareporting:v2.7/FsCommand: fs_command +/dfareporting:v2.7/FsCommand/left: left +/dfareporting:v2.7/FsCommand/positionOption: position_option +/dfareporting:v2.7/FsCommand/top: top +/dfareporting:v2.7/FsCommand/windowHeight: window_height +/dfareporting:v2.7/FsCommand/windowWidth: window_width +/dfareporting:v2.7/GeoTargeting: geo_targeting +/dfareporting:v2.7/GeoTargeting/cities: cities +/dfareporting:v2.7/GeoTargeting/cities/city: city +/dfareporting:v2.7/GeoTargeting/countries: countries +/dfareporting:v2.7/GeoTargeting/countries/country: country +/dfareporting:v2.7/GeoTargeting/excludeCountries: exclude_countries +/dfareporting:v2.7/GeoTargeting/metros: metros +/dfareporting:v2.7/GeoTargeting/metros/metro: metro +/dfareporting:v2.7/GeoTargeting/postalCodes: postal_codes +/dfareporting:v2.7/GeoTargeting/postalCodes/postal_code: postal_code +/dfareporting:v2.7/GeoTargeting/regions: regions +/dfareporting:v2.7/GeoTargeting/regions/region: region +/dfareporting:v2.7/InventoryItem: inventory_item +/dfareporting:v2.7/InventoryItem/accountId: account_id +/dfareporting:v2.7/InventoryItem/adSlots: ad_slots +/dfareporting:v2.7/InventoryItem/adSlots/ad_slot: ad_slot +/dfareporting:v2.7/InventoryItem/advertiserId: advertiser_id +/dfareporting:v2.7/InventoryItem/contentCategoryId: content_category_id +/dfareporting:v2.7/InventoryItem/estimatedClickThroughRate: estimated_click_through_rate +/dfareporting:v2.7/InventoryItem/estimatedConversionRate: estimated_conversion_rate +/dfareporting:v2.7/InventoryItem/id: id +/dfareporting:v2.7/InventoryItem/inPlan: in_plan +/dfareporting:v2.7/InventoryItem/kind: kind +/dfareporting:v2.7/InventoryItem/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/InventoryItem/name: name +/dfareporting:v2.7/InventoryItem/negotiationChannelId: negotiation_channel_id +/dfareporting:v2.7/InventoryItem/orderId: order_id +/dfareporting:v2.7/InventoryItem/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/InventoryItem/pricing: pricing +/dfareporting:v2.7/InventoryItem/projectId: project_id +/dfareporting:v2.7/InventoryItem/rfpId: rfp_id +/dfareporting:v2.7/InventoryItem/siteId: site_id +/dfareporting:v2.7/InventoryItem/subaccountId: subaccount_id +/dfareporting:v2.7/InventoryItem/type: type +/dfareporting:v2.7/InventoryItemsListResponse: inventory_items_list_response +/dfareporting:v2.7/InventoryItemsListResponse/inventoryItems: inventory_items +/dfareporting:v2.7/InventoryItemsListResponse/inventoryItems/inventory_item: inventory_item +/dfareporting:v2.7/InventoryItemsListResponse/kind: kind +/dfareporting:v2.7/InventoryItemsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/KeyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/KeyValueTargetingExpression/expression: expression +/dfareporting:v2.7/LandingPage: landing_page +/dfareporting:v2.7/LandingPage/default: default +/dfareporting:v2.7/LandingPage/id: id +/dfareporting:v2.7/LandingPage/kind: kind +/dfareporting:v2.7/LandingPage/name: name +/dfareporting:v2.7/LandingPage/url: url +/dfareporting:v2.7/LandingPagesListResponse: landing_pages_list_response +/dfareporting:v2.7/LandingPagesListResponse/kind: kind +/dfareporting:v2.7/LandingPagesListResponse/landingPages: landing_pages +/dfareporting:v2.7/LandingPagesListResponse/landingPages/landing_page: landing_page +/dfareporting:v2.7/Language: language +/dfareporting:v2.7/Language/id: id +/dfareporting:v2.7/Language/kind: kind +/dfareporting:v2.7/Language/languageCode: language_code +/dfareporting:v2.7/Language/name: name +/dfareporting:v2.7/LanguageTargeting: language_targeting +/dfareporting:v2.7/LanguageTargeting/languages: languages +/dfareporting:v2.7/LanguageTargeting/languages/language: language +/dfareporting:v2.7/LanguagesListResponse: languages_list_response +/dfareporting:v2.7/LanguagesListResponse/kind: kind +/dfareporting:v2.7/LanguagesListResponse/languages: languages +/dfareporting:v2.7/LanguagesListResponse/languages/language: language +/dfareporting:v2.7/LastModifiedInfo: last_modified_info +/dfareporting:v2.7/LastModifiedInfo/time: time +/dfareporting:v2.7/ListPopulationClause: list_population_clause +/dfareporting:v2.7/ListPopulationClause/terms: terms +/dfareporting:v2.7/ListPopulationClause/terms/term: term +/dfareporting:v2.7/ListPopulationRule: list_population_rule +/dfareporting:v2.7/ListPopulationRule/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/ListPopulationRule/floodlightActivityName: floodlight_activity_name +/dfareporting:v2.7/ListPopulationRule/listPopulationClauses: list_population_clauses +/dfareporting:v2.7/ListPopulationRule/listPopulationClauses/list_population_clause: list_population_clause +/dfareporting:v2.7/ListPopulationTerm: list_population_term +/dfareporting:v2.7/ListPopulationTerm/contains: contains +/dfareporting:v2.7/ListPopulationTerm/negation: negation +/dfareporting:v2.7/ListPopulationTerm/operator: operator +/dfareporting:v2.7/ListPopulationTerm/remarketingListId: remarketing_list_id +/dfareporting:v2.7/ListPopulationTerm/type: type +/dfareporting:v2.7/ListPopulationTerm/value: value +/dfareporting:v2.7/ListPopulationTerm/variableFriendlyName: variable_friendly_name +/dfareporting:v2.7/ListPopulationTerm/variableName: variable_name +/dfareporting:v2.7/ListTargetingExpression: list_targeting_expression +/dfareporting:v2.7/ListTargetingExpression/expression: expression +/dfareporting:v2.7/LookbackConfiguration: lookback_configuration +/dfareporting:v2.7/LookbackConfiguration/clickDuration: click_duration +/dfareporting:v2.7/LookbackConfiguration/postImpressionActivitiesDuration: post_impression_activities_duration +/dfareporting:v2.7/Metric: metric +/dfareporting:v2.7/Metric/kind: kind +/dfareporting:v2.7/Metric/name: name +/dfareporting:v2.7/Metro: metro +/dfareporting:v2.7/Metro/countryCode: country_code +/dfareporting:v2.7/Metro/countryDartId: country_dart_id +/dfareporting:v2.7/Metro/dartId: dart_id +/dfareporting:v2.7/Metro/dmaId: dma_id +/dfareporting:v2.7/Metro/kind: kind +/dfareporting:v2.7/Metro/metroCode: metro_code +/dfareporting:v2.7/Metro/name: name +/dfareporting:v2.7/MetrosListResponse: metros_list_response +/dfareporting:v2.7/MetrosListResponse/kind: kind +/dfareporting:v2.7/MetrosListResponse/metros: metros +/dfareporting:v2.7/MetrosListResponse/metros/metro: metro +/dfareporting:v2.7/MobileCarrier: mobile_carrier +/dfareporting:v2.7/MobileCarrier/countryCode: country_code +/dfareporting:v2.7/MobileCarrier/countryDartId: country_dart_id +/dfareporting:v2.7/MobileCarrier/id: id +/dfareporting:v2.7/MobileCarrier/kind: kind +/dfareporting:v2.7/MobileCarrier/name: name +/dfareporting:v2.7/MobileCarriersListResponse: mobile_carriers_list_response +/dfareporting:v2.7/MobileCarriersListResponse/kind: kind +/dfareporting:v2.7/MobileCarriersListResponse/mobileCarriers: mobile_carriers +/dfareporting:v2.7/MobileCarriersListResponse/mobileCarriers/mobile_carrier: mobile_carrier +/dfareporting:v2.7/ObjectFilter: object_filter +/dfareporting:v2.7/ObjectFilter/kind: kind +/dfareporting:v2.7/ObjectFilter/objectIds: object_ids +/dfareporting:v2.7/ObjectFilter/objectIds/object_id: object_id_prop +/dfareporting:v2.7/ObjectFilter/status: status +/dfareporting:v2.7/OffsetPosition: offset_position +/dfareporting:v2.7/OffsetPosition/left: left +/dfareporting:v2.7/OffsetPosition/top: top +/dfareporting:v2.7/OmnitureSettings: omniture_settings +/dfareporting:v2.7/OmnitureSettings/omnitureCostDataEnabled: omniture_cost_data_enabled +/dfareporting:v2.7/OmnitureSettings/omnitureIntegrationEnabled: omniture_integration_enabled +/dfareporting:v2.7/OperatingSystem: operating_system +/dfareporting:v2.7/OperatingSystem/dartId: dart_id +/dfareporting:v2.7/OperatingSystem/desktop: desktop +/dfareporting:v2.7/OperatingSystem/kind: kind +/dfareporting:v2.7/OperatingSystem/mobile: mobile +/dfareporting:v2.7/OperatingSystem/name: name +/dfareporting:v2.7/OperatingSystemVersion: operating_system_version +/dfareporting:v2.7/OperatingSystemVersion/id: id +/dfareporting:v2.7/OperatingSystemVersion/kind: kind +/dfareporting:v2.7/OperatingSystemVersion/majorVersion: major_version +/dfareporting:v2.7/OperatingSystemVersion/minorVersion: minor_version +/dfareporting:v2.7/OperatingSystemVersion/name: name +/dfareporting:v2.7/OperatingSystemVersion/operatingSystem: operating_system +/dfareporting:v2.7/OperatingSystemVersionsListResponse: operating_system_versions_list_response +/dfareporting:v2.7/OperatingSystemVersionsListResponse/kind: kind +/dfareporting:v2.7/OperatingSystemVersionsListResponse/operatingSystemVersions: operating_system_versions +/dfareporting:v2.7/OperatingSystemVersionsListResponse/operatingSystemVersions/operating_system_version: operating_system_version +/dfareporting:v2.7/OperatingSystemsListResponse: operating_systems_list_response +/dfareporting:v2.7/OperatingSystemsListResponse/kind: kind +/dfareporting:v2.7/OperatingSystemsListResponse/operatingSystems: operating_systems +/dfareporting:v2.7/OperatingSystemsListResponse/operatingSystems/operating_system: operating_system +/dfareporting:v2.7/OptimizationActivity: optimization_activity +/dfareporting:v2.7/OptimizationActivity/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/OptimizationActivity/floodlightActivityIdDimensionValue: floodlight_activity_id_dimension_value +/dfareporting:v2.7/OptimizationActivity/weight: weight +/dfareporting:v2.7/Order: order +/dfareporting:v2.7/Order/accountId: account_id +/dfareporting:v2.7/Order/advertiserId: advertiser_id +/dfareporting:v2.7/Order/approverUserProfileIds: approver_user_profile_ids +/dfareporting:v2.7/Order/approverUserProfileIds/approver_user_profile_id: approver_user_profile_id +/dfareporting:v2.7/Order/buyerInvoiceId: buyer_invoice_id +/dfareporting:v2.7/Order/buyerOrganizationName: buyer_organization_name +/dfareporting:v2.7/Order/comments: comments +/dfareporting:v2.7/Order/contacts: contacts +/dfareporting:v2.7/Order/contacts/contact: contact +/dfareporting:v2.7/Order/id: id +/dfareporting:v2.7/Order/kind: kind +/dfareporting:v2.7/Order/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Order/name: name +/dfareporting:v2.7/Order/notes: notes +/dfareporting:v2.7/Order/planningTermId: planning_term_id +/dfareporting:v2.7/Order/projectId: project_id +/dfareporting:v2.7/Order/sellerOrderId: seller_order_id +/dfareporting:v2.7/Order/sellerOrganizationName: seller_organization_name +/dfareporting:v2.7/Order/siteId: site_id +/dfareporting:v2.7/Order/siteId/site_id: site_id +/dfareporting:v2.7/Order/siteNames: site_names +/dfareporting:v2.7/Order/siteNames/site_name: site_name +/dfareporting:v2.7/Order/subaccountId: subaccount_id +/dfareporting:v2.7/Order/termsAndConditions: terms_and_conditions +/dfareporting:v2.7/OrderContact: order_contact +/dfareporting:v2.7/OrderContact/contactInfo: contact_info +/dfareporting:v2.7/OrderContact/contactName: contact_name +/dfareporting:v2.7/OrderContact/contactTitle: contact_title +/dfareporting:v2.7/OrderContact/contactType: contact_type +/dfareporting:v2.7/OrderContact/signatureUserProfileId: signature_user_profile_id +/dfareporting:v2.7/OrderDocument: order_document +/dfareporting:v2.7/OrderDocument/accountId: account_id +/dfareporting:v2.7/OrderDocument/advertiserId: advertiser_id +/dfareporting:v2.7/OrderDocument/amendedOrderDocumentId: amended_order_document_id +/dfareporting:v2.7/OrderDocument/approvedByUserProfileIds: approved_by_user_profile_ids +/dfareporting:v2.7/OrderDocument/approvedByUserProfileIds/approved_by_user_profile_id: approved_by_user_profile_id +/dfareporting:v2.7/OrderDocument/cancelled: cancelled +/dfareporting:v2.7/OrderDocument/createdInfo: created_info +/dfareporting:v2.7/OrderDocument/effectiveDate: effective_date +/dfareporting:v2.7/OrderDocument/id: id +/dfareporting:v2.7/OrderDocument/kind: kind +/dfareporting:v2.7/OrderDocument/lastSentRecipients: last_sent_recipients +/dfareporting:v2.7/OrderDocument/lastSentRecipients/last_sent_recipient: last_sent_recipient +/dfareporting:v2.7/OrderDocument/lastSentTime: last_sent_time +/dfareporting:v2.7/OrderDocument/orderId: order_id +/dfareporting:v2.7/OrderDocument/projectId: project_id +/dfareporting:v2.7/OrderDocument/signed: signed +/dfareporting:v2.7/OrderDocument/subaccountId: subaccount_id +/dfareporting:v2.7/OrderDocument/title: title +/dfareporting:v2.7/OrderDocument/type: type +/dfareporting:v2.7/OrderDocumentsListResponse: order_documents_list_response +/dfareporting:v2.7/OrderDocumentsListResponse/kind: kind +/dfareporting:v2.7/OrderDocumentsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/OrderDocumentsListResponse/orderDocuments: order_documents +/dfareporting:v2.7/OrderDocumentsListResponse/orderDocuments/order_document: order_document +/dfareporting:v2.7/OrdersListResponse: orders_list_response +/dfareporting:v2.7/OrdersListResponse/kind: kind +/dfareporting:v2.7/OrdersListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/OrdersListResponse/orders: orders +/dfareporting:v2.7/OrdersListResponse/orders/order: order +/dfareporting:v2.7/PathToConversionReportCompatibleFields: path_to_conversion_report_compatible_fields +/dfareporting:v2.7/PathToConversionReportCompatibleFields/conversionDimensions: conversion_dimensions +/dfareporting:v2.7/PathToConversionReportCompatibleFields/conversionDimensions/conversion_dimension: conversion_dimension +/dfareporting:v2.7/PathToConversionReportCompatibleFields/customFloodlightVariables: custom_floodlight_variables +/dfareporting:v2.7/PathToConversionReportCompatibleFields/customFloodlightVariables/custom_floodlight_variable: custom_floodlight_variable +/dfareporting:v2.7/PathToConversionReportCompatibleFields/kind: kind +/dfareporting:v2.7/PathToConversionReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/PathToConversionReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/PathToConversionReportCompatibleFields/perInteractionDimensions: per_interaction_dimensions +/dfareporting:v2.7/PathToConversionReportCompatibleFields/perInteractionDimensions/per_interaction_dimension: per_interaction_dimension +/dfareporting:v2.7/Placement: placement +/dfareporting:v2.7/Placement/accountId: account_id +/dfareporting:v2.7/Placement/advertiserId: advertiser_id +/dfareporting:v2.7/Placement/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/Placement/archived: archived +/dfareporting:v2.7/Placement/campaignId: campaign_id +/dfareporting:v2.7/Placement/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/Placement/comment: comment +/dfareporting:v2.7/Placement/compatibility: compatibility +/dfareporting:v2.7/Placement/contentCategoryId: content_category_id +/dfareporting:v2.7/Placement/createInfo: create_info +/dfareporting:v2.7/Placement/directorySiteId: directory_site_id +/dfareporting:v2.7/Placement/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/Placement/externalId: external_id +/dfareporting:v2.7/Placement/id: id +/dfareporting:v2.7/Placement/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Placement/keyName: key_name +/dfareporting:v2.7/Placement/kind: kind +/dfareporting:v2.7/Placement/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Placement/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/Placement/name: name +/dfareporting:v2.7/Placement/paymentApproved: payment_approved +/dfareporting:v2.7/Placement/paymentSource: payment_source +/dfareporting:v2.7/Placement/placementGroupId: placement_group_id +/dfareporting:v2.7/Placement/placementGroupIdDimensionValue: placement_group_id_dimension_value +/dfareporting:v2.7/Placement/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/Placement/pricingSchedule: pricing_schedule +/dfareporting:v2.7/Placement/primary: primary +/dfareporting:v2.7/Placement/publisherUpdateInfo: publisher_update_info +/dfareporting:v2.7/Placement/siteId: site_id +/dfareporting:v2.7/Placement/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/Placement/size: size +/dfareporting:v2.7/Placement/sslRequired: ssl_required +/dfareporting:v2.7/Placement/status: status +/dfareporting:v2.7/Placement/subaccountId: subaccount_id +/dfareporting:v2.7/Placement/tagFormats: tag_formats +/dfareporting:v2.7/Placement/tagFormats/tag_format: tag_format +/dfareporting:v2.7/Placement/tagSetting: tag_setting +/dfareporting:v2.7/Placement/videoActiveViewOptOut: video_active_view_opt_out +/dfareporting:v2.7/Placement/videoSettings: video_settings +/dfareporting:v2.7/Placement/vpaidAdapterChoice: vpaid_adapter_choice +/dfareporting:v2.7/PlacementAssignment: placement_assignment +/dfareporting:v2.7/PlacementAssignment/active: active +/dfareporting:v2.7/PlacementAssignment/placementId: placement_id +/dfareporting:v2.7/PlacementAssignment/placementIdDimensionValue: placement_id_dimension_value +/dfareporting:v2.7/PlacementAssignment/sslRequired: ssl_required +/dfareporting:v2.7/PlacementGroup: placement_group +/dfareporting:v2.7/PlacementGroup/accountId: account_id +/dfareporting:v2.7/PlacementGroup/advertiserId: advertiser_id +/dfareporting:v2.7/PlacementGroup/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/PlacementGroup/archived: archived +/dfareporting:v2.7/PlacementGroup/campaignId: campaign_id +/dfareporting:v2.7/PlacementGroup/campaignIdDimensionValue: campaign_id_dimension_value +/dfareporting:v2.7/PlacementGroup/childPlacementIds: child_placement_ids +/dfareporting:v2.7/PlacementGroup/childPlacementIds/child_placement_id: child_placement_id +/dfareporting:v2.7/PlacementGroup/comment: comment +/dfareporting:v2.7/PlacementGroup/contentCategoryId: content_category_id +/dfareporting:v2.7/PlacementGroup/createInfo: create_info +/dfareporting:v2.7/PlacementGroup/directorySiteId: directory_site_id +/dfareporting:v2.7/PlacementGroup/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/PlacementGroup/externalId: external_id +/dfareporting:v2.7/PlacementGroup/id: id +/dfareporting:v2.7/PlacementGroup/idDimensionValue: id_dimension_value +/dfareporting:v2.7/PlacementGroup/kind: kind +/dfareporting:v2.7/PlacementGroup/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/PlacementGroup/name: name +/dfareporting:v2.7/PlacementGroup/placementGroupType: placement_group_type +/dfareporting:v2.7/PlacementGroup/placementStrategyId: placement_strategy_id +/dfareporting:v2.7/PlacementGroup/pricingSchedule: pricing_schedule +/dfareporting:v2.7/PlacementGroup/primaryPlacementId: primary_placement_id +/dfareporting:v2.7/PlacementGroup/primaryPlacementIdDimensionValue: primary_placement_id_dimension_value +/dfareporting:v2.7/PlacementGroup/siteId: site_id +/dfareporting:v2.7/PlacementGroup/siteIdDimensionValue: site_id_dimension_value +/dfareporting:v2.7/PlacementGroup/subaccountId: subaccount_id +/dfareporting:v2.7/PlacementGroupsListResponse: placement_groups_list_response +/dfareporting:v2.7/PlacementGroupsListResponse/kind: kind +/dfareporting:v2.7/PlacementGroupsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementGroupsListResponse/placementGroups: placement_groups +/dfareporting:v2.7/PlacementGroupsListResponse/placementGroups/placement_group: placement_group +/dfareporting:v2.7/PlacementStrategiesListResponse: placement_strategies_list_response +/dfareporting:v2.7/PlacementStrategiesListResponse/kind: kind +/dfareporting:v2.7/PlacementStrategiesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementStrategiesListResponse/placementStrategies: placement_strategies +/dfareporting:v2.7/PlacementStrategiesListResponse/placementStrategies/placement_strategy: placement_strategy +/dfareporting:v2.7/PlacementStrategy: placement_strategy +/dfareporting:v2.7/PlacementStrategy/accountId: account_id +/dfareporting:v2.7/PlacementStrategy/id: id +/dfareporting:v2.7/PlacementStrategy/kind: kind +/dfareporting:v2.7/PlacementStrategy/name: name +/dfareporting:v2.7/PlacementTag: placement_tag +/dfareporting:v2.7/PlacementTag/placementId: placement_id +/dfareporting:v2.7/PlacementTag/tagDatas: tag_datas +/dfareporting:v2.7/PlacementTag/tagDatas/tag_data: tag_data +/dfareporting:v2.7/PlacementsGenerateTagsResponse: placements_generate_tags_response +/dfareporting:v2.7/PlacementsGenerateTagsResponse/kind: kind +/dfareporting:v2.7/PlacementsGenerateTagsResponse/placementTags: placement_tags +/dfareporting:v2.7/PlacementsGenerateTagsResponse/placementTags/placement_tag: placement_tag +/dfareporting:v2.7/PlacementsListResponse: placements_list_response +/dfareporting:v2.7/PlacementsListResponse/kind: kind +/dfareporting:v2.7/PlacementsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/PlacementsListResponse/placements: placements +/dfareporting:v2.7/PlacementsListResponse/placements/placement: placement +/dfareporting:v2.7/PlatformType: platform_type +/dfareporting:v2.7/PlatformType/id: id +/dfareporting:v2.7/PlatformType/kind: kind +/dfareporting:v2.7/PlatformType/name: name +/dfareporting:v2.7/PlatformTypesListResponse: platform_types_list_response +/dfareporting:v2.7/PlatformTypesListResponse/kind: kind +/dfareporting:v2.7/PlatformTypesListResponse/platformTypes: platform_types +/dfareporting:v2.7/PlatformTypesListResponse/platformTypes/platform_type: platform_type +/dfareporting:v2.7/PopupWindowProperties: popup_window_properties +/dfareporting:v2.7/PopupWindowProperties/dimension: dimension +/dfareporting:v2.7/PopupWindowProperties/offset: offset +/dfareporting:v2.7/PopupWindowProperties/positionType: position_type +/dfareporting:v2.7/PopupWindowProperties/showAddressBar: show_address_bar +/dfareporting:v2.7/PopupWindowProperties/showMenuBar: show_menu_bar +/dfareporting:v2.7/PopupWindowProperties/showScrollBar: show_scroll_bar +/dfareporting:v2.7/PopupWindowProperties/showStatusBar: show_status_bar +/dfareporting:v2.7/PopupWindowProperties/showToolBar: show_tool_bar +/dfareporting:v2.7/PopupWindowProperties/title: title +/dfareporting:v2.7/PostalCode: postal_code +/dfareporting:v2.7/PostalCode/code: code +/dfareporting:v2.7/PostalCode/countryCode: country_code +/dfareporting:v2.7/PostalCode/countryDartId: country_dart_id +/dfareporting:v2.7/PostalCode/id: id +/dfareporting:v2.7/PostalCode/kind: kind +/dfareporting:v2.7/PostalCodesListResponse: postal_codes_list_response +/dfareporting:v2.7/PostalCodesListResponse/kind: kind +/dfareporting:v2.7/PostalCodesListResponse/postalCodes: postal_codes +/dfareporting:v2.7/PostalCodesListResponse/postalCodes/postal_code: postal_code +/dfareporting:v2.7/Pricing: pricing +/dfareporting:v2.7/Pricing/capCostType: cap_cost_type +/dfareporting:v2.7/Pricing/endDate: end_date +/dfareporting:v2.7/Pricing/flights: flights +/dfareporting:v2.7/Pricing/flights/flight: flight +/dfareporting:v2.7/Pricing/groupType: group_type +/dfareporting:v2.7/Pricing/pricingType: pricing_type +/dfareporting:v2.7/Pricing/startDate: start_date +/dfareporting:v2.7/PricingSchedule: pricing_schedule +/dfareporting:v2.7/PricingSchedule/capCostOption: cap_cost_option +/dfareporting:v2.7/PricingSchedule/disregardOverdelivery: disregard_overdelivery +/dfareporting:v2.7/PricingSchedule/endDate: end_date +/dfareporting:v2.7/PricingSchedule/flighted: flighted +/dfareporting:v2.7/PricingSchedule/floodlightActivityId: floodlight_activity_id +/dfareporting:v2.7/PricingSchedule/pricingPeriods: pricing_periods +/dfareporting:v2.7/PricingSchedule/pricingPeriods/pricing_period: pricing_period +/dfareporting:v2.7/PricingSchedule/pricingType: pricing_type +/dfareporting:v2.7/PricingSchedule/startDate: start_date +/dfareporting:v2.7/PricingSchedule/testingStartDate: testing_start_date +/dfareporting:v2.7/PricingSchedulePricingPeriod: pricing_schedule_pricing_period +/dfareporting:v2.7/PricingSchedulePricingPeriod/endDate: end_date +/dfareporting:v2.7/PricingSchedulePricingPeriod/pricingComment: pricing_comment +/dfareporting:v2.7/PricingSchedulePricingPeriod/rateOrCostNanos: rate_or_cost_nanos +/dfareporting:v2.7/PricingSchedulePricingPeriod/startDate: start_date +/dfareporting:v2.7/PricingSchedulePricingPeriod/units: units +/dfareporting:v2.7/Project: project +/dfareporting:v2.7/Project/accountId: account_id +/dfareporting:v2.7/Project/advertiserId: advertiser_id +/dfareporting:v2.7/Project/audienceAgeGroup: audience_age_group +/dfareporting:v2.7/Project/audienceGender: audience_gender +/dfareporting:v2.7/Project/budget: budget +/dfareporting:v2.7/Project/clientBillingCode: client_billing_code +/dfareporting:v2.7/Project/clientName: client_name +/dfareporting:v2.7/Project/endDate: end_date +/dfareporting:v2.7/Project/id: id +/dfareporting:v2.7/Project/kind: kind +/dfareporting:v2.7/Project/lastModifiedInfo: last_modified_info +/dfareporting:v2.7/Project/name: name +/dfareporting:v2.7/Project/overview: overview +/dfareporting:v2.7/Project/startDate: start_date +/dfareporting:v2.7/Project/subaccountId: subaccount_id +/dfareporting:v2.7/Project/targetClicks: target_clicks +/dfareporting:v2.7/Project/targetConversions: target_conversions +/dfareporting:v2.7/Project/targetCpaNanos: target_cpa_nanos +/dfareporting:v2.7/Project/targetCpcNanos: target_cpc_nanos +/dfareporting:v2.7/Project/targetCpmActiveViewNanos: target_cpm_active_view_nanos +/dfareporting:v2.7/Project/targetCpmNanos: target_cpm_nanos +/dfareporting:v2.7/Project/targetImpressions: target_impressions +/dfareporting:v2.7/ProjectsListResponse: projects_list_response +/dfareporting:v2.7/ProjectsListResponse/kind: kind +/dfareporting:v2.7/ProjectsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/ProjectsListResponse/projects: projects +/dfareporting:v2.7/ProjectsListResponse/projects/project: project +/dfareporting:v2.7/ReachReportCompatibleFields: reach_report_compatible_fields +/dfareporting:v2.7/ReachReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/ReachReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/ReachReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/ReachReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/ReachReportCompatibleFields/kind: kind +/dfareporting:v2.7/ReachReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/ReachReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/ReachReportCompatibleFields/pivotedActivityMetrics: pivoted_activity_metrics +/dfareporting:v2.7/ReachReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric: pivoted_activity_metric +/dfareporting:v2.7/ReachReportCompatibleFields/reachByFrequencyMetrics: reach_by_frequency_metrics +/dfareporting:v2.7/ReachReportCompatibleFields/reachByFrequencyMetrics/reach_by_frequency_metric: reach_by_frequency_metric +/dfareporting:v2.7/Recipient: recipient +/dfareporting:v2.7/Recipient/deliveryType: delivery_type +/dfareporting:v2.7/Recipient/email: email +/dfareporting:v2.7/Recipient/kind: kind +/dfareporting:v2.7/Region: region +/dfareporting:v2.7/Region/countryCode: country_code +/dfareporting:v2.7/Region/countryDartId: country_dart_id +/dfareporting:v2.7/Region/dartId: dart_id +/dfareporting:v2.7/Region/kind: kind +/dfareporting:v2.7/Region/name: name +/dfareporting:v2.7/Region/regionCode: region_code +/dfareporting:v2.7/RegionsListResponse: regions_list_response +/dfareporting:v2.7/RegionsListResponse/kind: kind +/dfareporting:v2.7/RegionsListResponse/regions: regions +/dfareporting:v2.7/RegionsListResponse/regions/region: region +/dfareporting:v2.7/RemarketingList: remarketing_list +/dfareporting:v2.7/RemarketingList/accountId: account_id +/dfareporting:v2.7/RemarketingList/active: active +/dfareporting:v2.7/RemarketingList/advertiserId: advertiser_id +/dfareporting:v2.7/RemarketingList/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/RemarketingList/description: description +/dfareporting:v2.7/RemarketingList/id: id +/dfareporting:v2.7/RemarketingList/kind: kind +/dfareporting:v2.7/RemarketingList/lifeSpan: life_span +/dfareporting:v2.7/RemarketingList/listPopulationRule: list_population_rule +/dfareporting:v2.7/RemarketingList/listSize: list_size +/dfareporting:v2.7/RemarketingList/listSource: list_source +/dfareporting:v2.7/RemarketingList/name: name +/dfareporting:v2.7/RemarketingList/subaccountId: subaccount_id +/dfareporting:v2.7/RemarketingListShare: remarketing_list_share +/dfareporting:v2.7/RemarketingListShare/kind: kind +/dfareporting:v2.7/RemarketingListShare/remarketingListId: remarketing_list_id +/dfareporting:v2.7/RemarketingListShare/sharedAccountIds: shared_account_ids +/dfareporting:v2.7/RemarketingListShare/sharedAccountIds/shared_account_id: shared_account_id +/dfareporting:v2.7/RemarketingListShare/sharedAdvertiserIds: shared_advertiser_ids +/dfareporting:v2.7/RemarketingListShare/sharedAdvertiserIds/shared_advertiser_id: shared_advertiser_id +/dfareporting:v2.7/RemarketingListsListResponse: remarketing_lists_list_response +/dfareporting:v2.7/RemarketingListsListResponse/kind: kind +/dfareporting:v2.7/RemarketingListsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/RemarketingListsListResponse/remarketingLists: remarketing_lists +/dfareporting:v2.7/RemarketingListsListResponse/remarketingLists/remarketing_list: remarketing_list +/dfareporting:v2.7/Report: report +/dfareporting:v2.7/Report/accountId: account_id +/dfareporting:v2.7/Report/criteria: criteria +/dfareporting:v2.7/Report/criteria/activities: activities +/dfareporting:v2.7/Report/criteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/criteria/dateRange: date_range +/dfareporting:v2.7/Report/criteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/criteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/criteria/dimensions: dimensions +/dfareporting:v2.7/Report/criteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/criteria/metricNames: metric_names +/dfareporting:v2.7/Report/criteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria: cross_dimension_reach_criteria +/dfareporting:v2.7/Report/crossDimensionReachCriteria/breakdown: breakdown +/dfareporting:v2.7/Report/crossDimensionReachCriteria/breakdown/breakdown: breakdown +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dateRange: date_range +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimension: dimension +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/crossDimensionReachCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/crossDimensionReachCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/crossDimensionReachCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria/overlapMetricNames: overlap_metric_names +/dfareporting:v2.7/Report/crossDimensionReachCriteria/overlapMetricNames/overlap_metric_name: overlap_metric_name +/dfareporting:v2.7/Report/crossDimensionReachCriteria/pivoted: pivoted +/dfareporting:v2.7/Report/delivery: delivery +/dfareporting:v2.7/Report/delivery/emailOwner: email_owner +/dfareporting:v2.7/Report/delivery/emailOwnerDeliveryType: email_owner_delivery_type +/dfareporting:v2.7/Report/delivery/message: message +/dfareporting:v2.7/Report/delivery/recipients: recipients +/dfareporting:v2.7/Report/delivery/recipients/recipient: recipient +/dfareporting:v2.7/Report/etag: etag +/dfareporting:v2.7/Report/fileName: file_name +/dfareporting:v2.7/Report/floodlightCriteria: floodlight_criteria +/dfareporting:v2.7/Report/floodlightCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/floodlightCriteria/customRichMediaEvents/custom_rich_media_event: custom_rich_media_event +/dfareporting:v2.7/Report/floodlightCriteria/dateRange: date_range +/dfareporting:v2.7/Report/floodlightCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/floodlightCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/floodlightCriteria/dimensions: dimensions +/dfareporting:v2.7/Report/floodlightCriteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/floodlightCriteria/floodlightConfigId: floodlight_config_id +/dfareporting:v2.7/Report/floodlightCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/floodlightCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties: report_properties +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeAttributedIPConversions: include_attributed_ip_conversions +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeUnattributedCookieConversions: include_unattributed_cookie_conversions +/dfareporting:v2.7/Report/floodlightCriteria/reportProperties/includeUnattributedIPConversions: include_unattributed_ip_conversions +/dfareporting:v2.7/Report/format: format +/dfareporting:v2.7/Report/id: id +/dfareporting:v2.7/Report/kind: kind +/dfareporting:v2.7/Report/lastModifiedTime: last_modified_time +/dfareporting:v2.7/Report/name: name +/dfareporting:v2.7/Report/ownerProfileId: owner_profile_id +/dfareporting:v2.7/Report/pathToConversionCriteria: path_to_conversion_criteria +/dfareporting:v2.7/Report/pathToConversionCriteria/activityFilters: activity_filters +/dfareporting:v2.7/Report/pathToConversionCriteria/activityFilters/activity_filter: activity_filter +/dfareporting:v2.7/Report/pathToConversionCriteria/conversionDimensions: conversion_dimensions +/dfareporting:v2.7/Report/pathToConversionCriteria/conversionDimensions/conversion_dimension: conversion_dimension +/dfareporting:v2.7/Report/pathToConversionCriteria/customFloodlightVariables: custom_floodlight_variables +/dfareporting:v2.7/Report/pathToConversionCriteria/customFloodlightVariables/custom_floodlight_variable: custom_floodlight_variable +/dfareporting:v2.7/Report/pathToConversionCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/pathToConversionCriteria/customRichMediaEvents/custom_rich_media_event: custom_rich_media_event +/dfareporting:v2.7/Report/pathToConversionCriteria/dateRange: date_range +/dfareporting:v2.7/Report/pathToConversionCriteria/floodlightConfigId: floodlight_config_id +/dfareporting:v2.7/Report/pathToConversionCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/pathToConversionCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/pathToConversionCriteria/perInteractionDimensions: per_interaction_dimensions +/dfareporting:v2.7/Report/pathToConversionCriteria/perInteractionDimensions/per_interaction_dimension: per_interaction_dimension +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties: report_properties +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/clicksLookbackWindow: clicks_lookback_window +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/impressionsLookbackWindow: impressions_lookback_window +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeAttributedIPConversions: include_attributed_ip_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeUnattributedCookieConversions: include_unattributed_cookie_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/includeUnattributedIPConversions: include_unattributed_ip_conversions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumClickInteractions: maximum_click_interactions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumImpressionInteractions: maximum_impression_interactions +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/maximumInteractionGap: maximum_interaction_gap +/dfareporting:v2.7/Report/pathToConversionCriteria/reportProperties/pivotOnInteractionPath: pivot_on_interaction_path +/dfareporting:v2.7/Report/reachCriteria: reach_criteria +/dfareporting:v2.7/Report/reachCriteria/activities: activities +/dfareporting:v2.7/Report/reachCriteria/customRichMediaEvents: custom_rich_media_events +/dfareporting:v2.7/Report/reachCriteria/dateRange: date_range +/dfareporting:v2.7/Report/reachCriteria/dimensionFilters: dimension_filters +/dfareporting:v2.7/Report/reachCriteria/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/Report/reachCriteria/dimensions: dimensions +/dfareporting:v2.7/Report/reachCriteria/dimensions/dimension: dimension +/dfareporting:v2.7/Report/reachCriteria/enableAllDimensionCombinations: enable_all_dimension_combinations +/dfareporting:v2.7/Report/reachCriteria/metricNames: metric_names +/dfareporting:v2.7/Report/reachCriteria/metricNames/metric_name: metric_name +/dfareporting:v2.7/Report/reachCriteria/reachByFrequencyMetricNames: reach_by_frequency_metric_names +/dfareporting:v2.7/Report/reachCriteria/reachByFrequencyMetricNames/reach_by_frequency_metric_name: reach_by_frequency_metric_name +/dfareporting:v2.7/Report/schedule: schedule +/dfareporting:v2.7/Report/schedule/active: active +/dfareporting:v2.7/Report/schedule/every: every +/dfareporting:v2.7/Report/schedule/expirationDate: expiration_date +/dfareporting:v2.7/Report/schedule/repeats: repeats +/dfareporting:v2.7/Report/schedule/repeatsOnWeekDays: repeats_on_week_days +/dfareporting:v2.7/Report/schedule/repeatsOnWeekDays/repeats_on_week_day: repeats_on_week_day +/dfareporting:v2.7/Report/schedule/runsOnDayOfMonth: runs_on_day_of_month +/dfareporting:v2.7/Report/schedule/startDate: start_date +/dfareporting:v2.7/Report/subAccountId: sub_account_id +/dfareporting:v2.7/Report/type: type +/dfareporting:v2.7/ReportCompatibleFields: report_compatible_fields +/dfareporting:v2.7/ReportCompatibleFields/dimensionFilters: dimension_filters +/dfareporting:v2.7/ReportCompatibleFields/dimensionFilters/dimension_filter: dimension_filter +/dfareporting:v2.7/ReportCompatibleFields/dimensions: dimensions +/dfareporting:v2.7/ReportCompatibleFields/dimensions/dimension: dimension +/dfareporting:v2.7/ReportCompatibleFields/kind: kind +/dfareporting:v2.7/ReportCompatibleFields/metrics: metrics +/dfareporting:v2.7/ReportCompatibleFields/metrics/metric: metric +/dfareporting:v2.7/ReportCompatibleFields/pivotedActivityMetrics: pivoted_activity_metrics +/dfareporting:v2.7/ReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric: pivoted_activity_metric +/dfareporting:v2.7/ReportList: report_list +/dfareporting:v2.7/ReportList/etag: etag +/dfareporting:v2.7/ReportList/items: items +/dfareporting:v2.7/ReportList/items/item: item +/dfareporting:v2.7/ReportList/kind: kind +/dfareporting:v2.7/ReportList/nextPageToken: next_page_token +/dfareporting:v2.7/ReportsConfiguration: reports_configuration +/dfareporting:v2.7/ReportsConfiguration/exposureToConversionEnabled: exposure_to_conversion_enabled +/dfareporting:v2.7/ReportsConfiguration/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/ReportsConfiguration/reportGenerationTimeZoneId: report_generation_time_zone_id +/dfareporting:v2.7/RichMediaExitOverride: rich_media_exit_override +/dfareporting:v2.7/RichMediaExitOverride/clickThroughUrl: click_through_url +/dfareporting:v2.7/RichMediaExitOverride/enabled: enabled +/dfareporting:v2.7/RichMediaExitOverride/exitId: exit_id +/dfareporting:v2.7/Rule: rule +/dfareporting:v2.7/Rule/assetId: asset_id +/dfareporting:v2.7/Rule/name: name +/dfareporting:v2.7/Rule/targetingTemplateId: targeting_template_id +/dfareporting:v2.7/Site: site +/dfareporting:v2.7/Site/accountId: account_id +/dfareporting:v2.7/Site/approved: approved +/dfareporting:v2.7/Site/directorySiteId: directory_site_id +/dfareporting:v2.7/Site/directorySiteIdDimensionValue: directory_site_id_dimension_value +/dfareporting:v2.7/Site/id: id +/dfareporting:v2.7/Site/idDimensionValue: id_dimension_value +/dfareporting:v2.7/Site/keyName: key_name +/dfareporting:v2.7/Site/kind: kind +/dfareporting:v2.7/Site/name: name +/dfareporting:v2.7/Site/siteContacts: site_contacts +/dfareporting:v2.7/Site/siteContacts/site_contact: site_contact +/dfareporting:v2.7/Site/siteSettings: site_settings +/dfareporting:v2.7/Site/subaccountId: subaccount_id +/dfareporting:v2.7/SiteContact: site_contact +/dfareporting:v2.7/SiteContact/address: address +/dfareporting:v2.7/SiteContact/contactType: contact_type +/dfareporting:v2.7/SiteContact/email: email +/dfareporting:v2.7/SiteContact/firstName: first_name +/dfareporting:v2.7/SiteContact/id: id +/dfareporting:v2.7/SiteContact/lastName: last_name +/dfareporting:v2.7/SiteContact/phone: phone +/dfareporting:v2.7/SiteContact/title: title +/dfareporting:v2.7/SiteSettings: site_settings +/dfareporting:v2.7/SiteSettings/activeViewOptOut: active_view_opt_out +/dfareporting:v2.7/SiteSettings/creativeSettings: creative_settings +/dfareporting:v2.7/SiteSettings/disableBrandSafeAds: disable_brand_safe_ads +/dfareporting:v2.7/SiteSettings/disableNewCookie: disable_new_cookie +/dfareporting:v2.7/SiteSettings/lookbackConfiguration: lookback_configuration +/dfareporting:v2.7/SiteSettings/tagSetting: tag_setting +/dfareporting:v2.7/SiteSettings/videoActiveViewOptOutTemplate: video_active_view_opt_out_template +/dfareporting:v2.7/SiteSettings/vpaidAdapterChoiceTemplate: vpaid_adapter_choice_template +/dfareporting:v2.7/SitesListResponse: sites_list_response +/dfareporting:v2.7/SitesListResponse/kind: kind +/dfareporting:v2.7/SitesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/SitesListResponse/sites: sites +/dfareporting:v2.7/SitesListResponse/sites/site: site +/dfareporting:v2.7/Size: size +/dfareporting:v2.7/Size/height: height +/dfareporting:v2.7/Size/iab: iab +/dfareporting:v2.7/Size/id: id +/dfareporting:v2.7/Size/kind: kind +/dfareporting:v2.7/Size/width: width +/dfareporting:v2.7/SizesListResponse: sizes_list_response +/dfareporting:v2.7/SizesListResponse/kind: kind +/dfareporting:v2.7/SizesListResponse/sizes: sizes +/dfareporting:v2.7/SizesListResponse/sizes/size: size +/dfareporting:v2.7/SkippableSetting: skippable_setting +/dfareporting:v2.7/SkippableSetting/kind: kind +/dfareporting:v2.7/SkippableSetting/progressOffset: progress_offset +/dfareporting:v2.7/SkippableSetting/skipOffset: skip_offset +/dfareporting:v2.7/SkippableSetting/skippable: skippable +/dfareporting:v2.7/SortedDimension: sorted_dimension +/dfareporting:v2.7/SortedDimension/kind: kind +/dfareporting:v2.7/SortedDimension/name: name +/dfareporting:v2.7/SortedDimension/sortOrder: sort_order +/dfareporting:v2.7/Subaccount: subaccount +/dfareporting:v2.7/Subaccount/accountId: account_id +/dfareporting:v2.7/Subaccount/availablePermissionIds: available_permission_ids +/dfareporting:v2.7/Subaccount/availablePermissionIds/available_permission_id: available_permission_id +/dfareporting:v2.7/Subaccount/id: id +/dfareporting:v2.7/Subaccount/kind: kind +/dfareporting:v2.7/Subaccount/name: name +/dfareporting:v2.7/SubaccountsListResponse: subaccounts_list_response +/dfareporting:v2.7/SubaccountsListResponse/kind: kind +/dfareporting:v2.7/SubaccountsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/SubaccountsListResponse/subaccounts: subaccounts +/dfareporting:v2.7/SubaccountsListResponse/subaccounts/subaccount: subaccount +/dfareporting:v2.7/TagData: tag_data +/dfareporting:v2.7/TagData/adId: ad_id +/dfareporting:v2.7/TagData/clickTag: click_tag +/dfareporting:v2.7/TagData/creativeId: creative_id +/dfareporting:v2.7/TagData/format: format +/dfareporting:v2.7/TagData/impressionTag: impression_tag +/dfareporting:v2.7/TagSetting: tag_setting +/dfareporting:v2.7/TagSetting/additionalKeyValues: additional_key_values +/dfareporting:v2.7/TagSetting/includeClickThroughUrls: include_click_through_urls +/dfareporting:v2.7/TagSetting/includeClickTracking: include_click_tracking +/dfareporting:v2.7/TagSetting/keywordOption: keyword_option +/dfareporting:v2.7/TagSettings: tag_settings +/dfareporting:v2.7/TagSettings/dynamicTagEnabled: dynamic_tag_enabled +/dfareporting:v2.7/TagSettings/imageTagEnabled: image_tag_enabled +/dfareporting:v2.7/TargetWindow: target_window +/dfareporting:v2.7/TargetWindow/customHtml: custom_html +/dfareporting:v2.7/TargetWindow/targetWindowOption: target_window_option +/dfareporting:v2.7/TargetableRemarketingList: targetable_remarketing_list +/dfareporting:v2.7/TargetableRemarketingList/accountId: account_id +/dfareporting:v2.7/TargetableRemarketingList/active: active +/dfareporting:v2.7/TargetableRemarketingList/advertiserId: advertiser_id +/dfareporting:v2.7/TargetableRemarketingList/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/TargetableRemarketingList/description: description +/dfareporting:v2.7/TargetableRemarketingList/id: id +/dfareporting:v2.7/TargetableRemarketingList/kind: kind +/dfareporting:v2.7/TargetableRemarketingList/lifeSpan: life_span +/dfareporting:v2.7/TargetableRemarketingList/listSize: list_size +/dfareporting:v2.7/TargetableRemarketingList/listSource: list_source +/dfareporting:v2.7/TargetableRemarketingList/name: name +/dfareporting:v2.7/TargetableRemarketingList/subaccountId: subaccount_id +/dfareporting:v2.7/TargetableRemarketingListsListResponse: targetable_remarketing_lists_list_response +/dfareporting:v2.7/TargetableRemarketingListsListResponse/kind: kind +/dfareporting:v2.7/TargetableRemarketingListsListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/TargetableRemarketingListsListResponse/targetableRemarketingLists: targetable_remarketing_lists +/dfareporting:v2.7/TargetableRemarketingListsListResponse/targetableRemarketingLists/targetable_remarketing_list: targetable_remarketing_list +/dfareporting:v2.7/TargetingTemplate: targeting_template +/dfareporting:v2.7/TargetingTemplate/accountId: account_id +/dfareporting:v2.7/TargetingTemplate/advertiserId: advertiser_id +/dfareporting:v2.7/TargetingTemplate/advertiserIdDimensionValue: advertiser_id_dimension_value +/dfareporting:v2.7/TargetingTemplate/dayPartTargeting: day_part_targeting +/dfareporting:v2.7/TargetingTemplate/geoTargeting: geo_targeting +/dfareporting:v2.7/TargetingTemplate/id: id +/dfareporting:v2.7/TargetingTemplate/keyValueTargetingExpression: key_value_targeting_expression +/dfareporting:v2.7/TargetingTemplate/kind: kind +/dfareporting:v2.7/TargetingTemplate/languageTargeting: language_targeting +/dfareporting:v2.7/TargetingTemplate/listTargetingExpression: list_targeting_expression +/dfareporting:v2.7/TargetingTemplate/name: name +/dfareporting:v2.7/TargetingTemplate/subaccountId: subaccount_id +/dfareporting:v2.7/TargetingTemplate/technologyTargeting: technology_targeting +/dfareporting:v2.7/TargetingTemplatesListResponse: targeting_templates_list_response +/dfareporting:v2.7/TargetingTemplatesListResponse/kind: kind +/dfareporting:v2.7/TargetingTemplatesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/TargetingTemplatesListResponse/targetingTemplates: targeting_templates +/dfareporting:v2.7/TargetingTemplatesListResponse/targetingTemplates/targeting_template: targeting_template +/dfareporting:v2.7/TechnologyTargeting: technology_targeting +/dfareporting:v2.7/TechnologyTargeting/browsers: browsers +/dfareporting:v2.7/TechnologyTargeting/browsers/browser: browser +/dfareporting:v2.7/TechnologyTargeting/connectionTypes: connection_types +/dfareporting:v2.7/TechnologyTargeting/connectionTypes/connection_type: connection_type +/dfareporting:v2.7/TechnologyTargeting/mobileCarriers: mobile_carriers +/dfareporting:v2.7/TechnologyTargeting/mobileCarriers/mobile_carrier: mobile_carrier +/dfareporting:v2.7/TechnologyTargeting/operatingSystemVersions: operating_system_versions +/dfareporting:v2.7/TechnologyTargeting/operatingSystemVersions/operating_system_version: operating_system_version +/dfareporting:v2.7/TechnologyTargeting/operatingSystems: operating_systems +/dfareporting:v2.7/TechnologyTargeting/operatingSystems/operating_system: operating_system +/dfareporting:v2.7/TechnologyTargeting/platformTypes: platform_types +/dfareporting:v2.7/TechnologyTargeting/platformTypes/platform_type: platform_type +/dfareporting:v2.7/ThirdPartyAuthenticationToken: third_party_authentication_token +/dfareporting:v2.7/ThirdPartyAuthenticationToken/name: name +/dfareporting:v2.7/ThirdPartyAuthenticationToken/value: value +/dfareporting:v2.7/ThirdPartyTrackingUrl: third_party_tracking_url +/dfareporting:v2.7/ThirdPartyTrackingUrl/thirdPartyUrlType: third_party_url_type +/dfareporting:v2.7/ThirdPartyTrackingUrl/url: url +/dfareporting:v2.7/TranscodeSetting: transcode_setting +/dfareporting:v2.7/TranscodeSetting/enabledVideoFormats: enabled_video_formats +/dfareporting:v2.7/TranscodeSetting/enabledVideoFormats/enabled_video_format: enabled_video_format +/dfareporting:v2.7/TranscodeSetting/kind: kind +/dfareporting:v2.7/UserDefinedVariableConfiguration: user_defined_variable_configuration +/dfareporting:v2.7/UserDefinedVariableConfiguration/dataType: data_type +/dfareporting:v2.7/UserDefinedVariableConfiguration/reportName: report_name +/dfareporting:v2.7/UserDefinedVariableConfiguration/variableType: variable_type +/dfareporting:v2.7/UserProfile: user_profile +/dfareporting:v2.7/UserProfile/accountId: account_id +/dfareporting:v2.7/UserProfile/accountName: account_name +/dfareporting:v2.7/UserProfile/etag: etag +/dfareporting:v2.7/UserProfile/kind: kind +/dfareporting:v2.7/UserProfile/profileId: profile_id +/dfareporting:v2.7/UserProfile/subAccountId: sub_account_id +/dfareporting:v2.7/UserProfile/subAccountName: sub_account_name +/dfareporting:v2.7/UserProfile/userName: user_name +/dfareporting:v2.7/UserProfileList: user_profile_list +/dfareporting:v2.7/UserProfileList/etag: etag +/dfareporting:v2.7/UserProfileList/items: items +/dfareporting:v2.7/UserProfileList/items/item: item +/dfareporting:v2.7/UserProfileList/kind: kind +/dfareporting:v2.7/UserRole: user_role +/dfareporting:v2.7/UserRole/accountId: account_id +/dfareporting:v2.7/UserRole/defaultUserRole: default_user_role +/dfareporting:v2.7/UserRole/id: id +/dfareporting:v2.7/UserRole/kind: kind +/dfareporting:v2.7/UserRole/name: name +/dfareporting:v2.7/UserRole/parentUserRoleId: parent_user_role_id +/dfareporting:v2.7/UserRole/permissions: permissions +/dfareporting:v2.7/UserRole/permissions/permission: permission +/dfareporting:v2.7/UserRole/subaccountId: subaccount_id +/dfareporting:v2.7/UserRolePermission: user_role_permission +/dfareporting:v2.7/UserRolePermission/availability: availability +/dfareporting:v2.7/UserRolePermission/id: id +/dfareporting:v2.7/UserRolePermission/kind: kind +/dfareporting:v2.7/UserRolePermission/name: name +/dfareporting:v2.7/UserRolePermission/permissionGroupId: permission_group_id +/dfareporting:v2.7/UserRolePermissionGroup: user_role_permission_group +/dfareporting:v2.7/UserRolePermissionGroup/id: id +/dfareporting:v2.7/UserRolePermissionGroup/kind: kind +/dfareporting:v2.7/UserRolePermissionGroup/name: name +/dfareporting:v2.7/UserRolePermissionGroupsListResponse: user_role_permission_groups_list_response +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/kind: kind +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/userRolePermissionGroups: user_role_permission_groups +/dfareporting:v2.7/UserRolePermissionGroupsListResponse/userRolePermissionGroups/user_role_permission_group: user_role_permission_group +/dfareporting:v2.7/UserRolePermissionsListResponse: user_role_permissions_list_response +/dfareporting:v2.7/UserRolePermissionsListResponse/kind: kind +/dfareporting:v2.7/UserRolePermissionsListResponse/userRolePermissions: user_role_permissions +/dfareporting:v2.7/UserRolePermissionsListResponse/userRolePermissions/user_role_permission: user_role_permission +/dfareporting:v2.7/UserRolesListResponse: user_roles_list_response +/dfareporting:v2.7/UserRolesListResponse/kind: kind +/dfareporting:v2.7/UserRolesListResponse/nextPageToken: next_page_token +/dfareporting:v2.7/UserRolesListResponse/userRoles: user_roles +/dfareporting:v2.7/UserRolesListResponse/userRoles/user_role: user_role +/dfareporting:v2.7/VideoFormat: video_format +/dfareporting:v2.7/VideoFormat/fileType: file_type +/dfareporting:v2.7/VideoFormat/id: id +/dfareporting:v2.7/VideoFormat/kind: kind +/dfareporting:v2.7/VideoFormat/resolution: resolution +/dfareporting:v2.7/VideoFormat/targetBitRate: target_bit_rate +/dfareporting:v2.7/VideoFormatsListResponse: video_formats_list_response +/dfareporting:v2.7/VideoFormatsListResponse/kind: kind +/dfareporting:v2.7/VideoFormatsListResponse/videoFormats: video_formats +/dfareporting:v2.7/VideoFormatsListResponse/videoFormats/video_format: video_format +/dfareporting:v2.7/VideoOffset: video_offset +/dfareporting:v2.7/VideoOffset/offsetPercentage: offset_percentage +/dfareporting:v2.7/VideoOffset/offsetSeconds: offset_seconds +/dfareporting:v2.7/VideoSettings: video_settings +/dfareporting:v2.7/VideoSettings/companionSettings: companion_settings +/dfareporting:v2.7/VideoSettings/kind: kind +/dfareporting:v2.7/VideoSettings/skippableSettings: skippable_settings +/dfareporting:v2.7/VideoSettings/transcodeSettings: transcode_settings diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index 6d3d8b09d..3c2bc9c9f 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20170118' + REVISION = '20170123' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adsense_v1_4.rb b/generated/google/apis/adsense_v1_4.rb index 3e95e3b02..a945a3672 100644 --- a/generated/google/apis/adsense_v1_4.rb +++ b/generated/google/apis/adsense_v1_4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/adsense/management/ module AdsenseV1_4 VERSION = 'V1_4' - REVISION = '20170118' + REVISION = '20170123' # View and manage your AdSense data AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense' diff --git a/generated/google/apis/adsensehost_v4_1.rb b/generated/google/apis/adsensehost_v4_1.rb index 14075dc29..aa61c465b 100644 --- a/generated/google/apis/adsensehost_v4_1.rb +++ b/generated/google/apis/adsensehost_v4_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/adsense/host/ module AdsensehostV4_1 VERSION = 'V4_1' - REVISION = '20170118' + REVISION = '20170123' # View and manage your AdSense host data and associated accounts AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost' diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index fa78471d4..cac884374 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20170111' + REVISION = '20170117' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/service.rb b/generated/google/apis/androidenterprise_v1/service.rb index f6a6a153c..59422f5a0 100644 --- a/generated/google/apis/androidenterprise_v1/service.rb +++ b/generated/google/apis/androidenterprise_v1/service.rb @@ -2214,52 +2214,6 @@ module Google execute_or_queue_command(command, &block) end - # This method has been deprecated. To programmatically approve applications, you - # must use the iframe mechanism via the generateApprovalUrl and approve - # methods of the Products resource. For more information, see the Play EMM API - # usage requirements. - # The updatePermissions method (deprecated) updates the set of Android app - # permissions for this app that have been accepted by the enterprise. - # @param [String] enterprise_id - # The ID of the enterprise. - # @param [String] product_id - # The ID of the product. - # @param [Google::Apis::AndroidenterpriseV1::ProductPermissions] product_permissions_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidenterpriseV1::ProductPermissions] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidenterpriseV1::ProductPermissions] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_product_permissions(enterprise_id, product_id, product_permissions_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/products/{productId}/permissions', options) - command.request_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation - command.request_object = product_permissions_object - command.response_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation - command.response_class = Google::Apis::AndroidenterpriseV1::ProductPermissions - command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? - command.params['productId'] = product_id unless product_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Removes and invalidates the specified credentials for the service account # associated with this enterprise. The calling service account must have been # retrieved by calling Enterprises.GetServiceAccount and must have been set as diff --git a/generated/google/apis/appstate_v1.rb b/generated/google/apis/appstate_v1.rb index baddabc85..174ad9683 100644 --- a/generated/google/apis/appstate_v1.rb +++ b/generated/google/apis/appstate_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/web/api/states module AppstateV1 VERSION = 'V1' - REVISION = '20170111' + REVISION = '20170119' # View and manage your data for this application AUTH_APPSTATE = 'https://www.googleapis.com/auth/appstate' diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index 104962bd9..835edbaa2 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/container-builder/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20170119' + REVISION = '20170124' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index e7e132221..812ae7269 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -22,65 +22,19 @@ module Google module Apis module CloudbuildV1 - # The `Status` type defines a logical error model that is suitable for different - # programming environments, including REST APIs and RPC APIs. It is used by - # [gRPC](https://github.com/grpc). The error model is designed to be: - # - Simple to use and understand for most users - # - Flexible enough to meet unexpected needs - # # Overview - # The `Status` message contains three pieces of data: error code, error message, - # and error details. The error code should be an enum value of - # google.rpc.Code, but it may accept additional error codes if needed. The - # error message should be a developer-facing English message that helps - # developers *understand* and *resolve* the error. If a localized user-facing - # error message is needed, put the localized message in the error details or - # localize it in the client. The optional error details may contain arbitrary - # information about the error. There is a predefined set of error detail types - # in the package `google.rpc` which can be used for common error conditions. - # # Language mapping - # The `Status` message is the logical representation of the error model, but it - # is not necessarily the actual wire format. When the `Status` message is - # exposed in different client libraries and different wire protocols, it can be - # mapped differently. For example, it will likely be mapped to some exceptions - # in Java, but more likely mapped to some error codes in C. - # # Other uses - # The error model and the `Status` message can be used in a variety of - # environments, either with or without APIs, to provide a - # consistent developer experience across different environments. - # Example uses of this error model include: - # - Partial errors. If a service needs to return partial errors to the client, - # it may embed the `Status` in the normal response to indicate the partial - # errors. - # - Workflow errors. A typical workflow has multiple steps. Each step may - # have a `Status` message for error reporting purpose. - # - Batch operations. If a client uses batch request and batch response, the - # `Status` message should be used directly inside batch response, one for - # each error sub-response. - # - Asynchronous operations. If an API call embeds asynchronous operation - # results in its response, the status of those operations should be - # represented directly using the `Status` message. - # - Logging. If some API errors are stored in logs, the message `Status` could - # be used directly after any stripping needed for security/privacy reasons. - class Status + # Response including listed builds. + class ListBuildsResponse include Google::Apis::Core::Hashable - # The status code, which should be an enum value of google.rpc.Code. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - - # A list of messages that carry the error details. There will be a - # common set of message types for APIs to use. - # Corresponds to the JSON property `details` - # @return [Array>] - attr_accessor :details - - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. - # Corresponds to the JSON property `message` + # Token to receive the next page of results. + # Corresponds to the JSON property `nextPageToken` # @return [String] - attr_accessor :message + attr_accessor :next_page_token + + # Builds will be sorted by create_time, descending. + # Corresponds to the JSON property `builds` + # @return [Array] + attr_accessor :builds def initialize(**args) update!(**args) @@ -88,9 +42,149 @@ module Google # Update properties of this object def update!(**args) - @code = args[:code] if args.key?(:code) - @details = args[:details] if args.key?(:details) - @message = args[:message] if args.key?(:message) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @builds = args[:builds] if args.key?(:builds) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # Source describes the location of the source in a supported storage + # service. + class Source + include Google::Apis::Core::Hashable + + # StorageSource describes the location of the source in an archive file in + # Google Cloud Storage. + # Corresponds to the JSON property `storageSource` + # @return [Google::Apis::CloudbuildV1::StorageSource] + attr_accessor :storage_source + + # RepoSource describes the location of the source in a Google Cloud Source + # Repository. + # Corresponds to the JSON property `repoSource` + # @return [Google::Apis::CloudbuildV1::RepoSource] + attr_accessor :repo_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @storage_source = args[:storage_source] if args.key?(:storage_source) + @repo_source = args[:repo_source] if args.key?(:repo_source) + end + end + + # Optional arguments to enable specific features of builds. + class BuildOptions + include Google::Apis::Core::Hashable + + # Requested hash for SourceProvenance. + # Corresponds to the JSON property `sourceProvenanceHash` + # @return [Array] + attr_accessor :source_provenance_hash + + # Requested verifiability options. + # Corresponds to the JSON property `requestedVerifyOption` + # @return [String] + attr_accessor :requested_verify_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash) + @requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option) + end + end + + # StorageSource describes the location of the source in an archive file in + # Google Cloud Storage. + class StorageSource + include Google::Apis::Core::Hashable + + # Google Cloud Storage bucket containing source (see + # [Bucket Name + # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) + # ). + # Corresponds to the JSON property `bucket` + # @return [String] + attr_accessor :bucket + + # Google Cloud Storage object containing source. + # This object must be a gzipped archive file (.tar.gz) containing source to + # build. + # Corresponds to the JSON property `object` + # @return [String] + attr_accessor :object + + # Google Cloud Storage generation for the object. If the generation is + # omitted, the latest generation will be used. + # Corresponds to the JSON property `generation` + # @return [String] + attr_accessor :generation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket = args[:bucket] if args.key?(:bucket) + @object = args[:object] if args.key?(:object) + @generation = args[:generation] if args.key?(:generation) + end + end + + # Results describes the artifacts created by the build pipeline. + class Results + include Google::Apis::Core::Hashable + + # Images that were built as a part of the build. + # Corresponds to the JSON property `images` + # @return [Array] + attr_accessor :images + + # List of build step digests, in order corresponding to build step indices. + # Corresponds to the JSON property `buildStepImages` + # @return [Array] + attr_accessor :build_step_images + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @images = args[:images] if args.key?(:images) + @build_step_images = args[:build_step_images] if args.key?(:build_step_images) end end @@ -125,51 +219,11 @@ module Google end end - # Source describes the location of the source in a supported storage - # service. - class Source - include Google::Apis::Core::Hashable - - # StorageSource describes the location of the source in an archive file in - # Google Cloud Storage. - # Corresponds to the JSON property `storageSource` - # @return [Google::Apis::CloudbuildV1::StorageSource] - attr_accessor :storage_source - - # RepoSource describes the location of the source in a Google Cloud Source - # Repository. - # Corresponds to the JSON property `repoSource` - # @return [Google::Apis::CloudbuildV1::RepoSource] - attr_accessor :repo_source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @storage_source = args[:storage_source] if args.key?(:storage_source) - @repo_source = args[:repo_source] if args.key?(:repo_source) - end - end - # Provenance of the source. Ways to find the original source, or verify that # some source was used for this build. class SourceProvenance include Google::Apis::Core::Hashable - # RepoSource describes the location of the source in a Google Cloud Source - # Repository. - # Corresponds to the JSON property `resolvedRepoSource` - # @return [Google::Apis::CloudbuildV1::RepoSource] - attr_accessor :resolved_repo_source - - # StorageSource describes the location of the source in an archive file in - # Google Cloud Storage. - # Corresponds to the JSON property `resolvedStorageSource` - # @return [Google::Apis::CloudbuildV1::StorageSource] - attr_accessor :resolved_storage_source - # Hash(es) of the build source, which can be used to verify that the original # source integrity was maintained in the build. Note that FileHashes will # only be populated if BuildOptions has requested a SourceProvenanceHash. @@ -182,15 +236,40 @@ module Google # @return [Hash] attr_accessor :file_hashes + # RepoSource describes the location of the source in a Google Cloud Source + # Repository. + # Corresponds to the JSON property `resolvedRepoSource` + # @return [Google::Apis::CloudbuildV1::RepoSource] + attr_accessor :resolved_repo_source + + # StorageSource describes the location of the source in an archive file in + # Google Cloud Storage. + # Corresponds to the JSON property `resolvedStorageSource` + # @return [Google::Apis::CloudbuildV1::StorageSource] + attr_accessor :resolved_storage_source + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @file_hashes = args[:file_hashes] if args.key?(:file_hashes) @resolved_repo_source = args[:resolved_repo_source] if args.key?(:resolved_repo_source) @resolved_storage_source = args[:resolved_storage_source] if args.key?(:resolved_storage_source) - @file_hashes = args[:file_hashes] if args.key?(:file_hashes) + end + end + + # The request message for Operations.CancelOperation. + class CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) end end @@ -199,6 +278,33 @@ module Google class Operation include Google::Apis::Core::Hashable + # If the value is `false`, it means the operation is still in progress. + # If true, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should have the format of `operations/some/unique/name`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: @@ -242,14 +348,6 @@ module Google # @return [Google::Apis::CloudbuildV1::Status] attr_accessor :error - # If the value is `false`, it means the operation is still in progress. - # If true, the operation is completed, and either `error` or `response` is - # available. - # Corresponds to the JSON property `done` - # @return [Boolean] - attr_accessor :done - alias_method :done?, :done - # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a @@ -258,389 +356,17 @@ module Google # @return [Hash] attr_accessor :metadata - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. - # Corresponds to the JSON property `response` - # @return [Hash] - attr_accessor :response - - # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should have the format of `operations/some/unique/name`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @error = args[:error] if args.key?(:error) @done = args[:done] if args.key?(:done) - @metadata = args[:metadata] if args.key?(:metadata) @response = args[:response] if args.key?(:response) @name = args[:name] if args.key?(:name) - end - end - - # Configuration for an automated build in response to source repository - # changes. - class BuildTrigger - include Google::Apis::Core::Hashable - - # Unique identifier of the trigger. - # @OutputOnly - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Human-readable description of this trigger. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # RepoSource describes the location of the source in a Google Cloud Source - # Repository. - # Corresponds to the JSON property `triggerTemplate` - # @return [Google::Apis::CloudbuildV1::RepoSource] - attr_accessor :trigger_template - - # If true, the trigger will never result in a build. - # Corresponds to the JSON property `disabled` - # @return [Boolean] - attr_accessor :disabled - alias_method :disabled?, :disabled - - # Time when the trigger was created. - # @OutputOnly - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Path, from the source root, to a file whose contents is used for the - # template. - # Corresponds to the JSON property `filename` - # @return [String] - attr_accessor :filename - - # A build resource in the Container Builder API. - # At a high level, a Build describes where to find source code, how to build - # it (for example, the builder image to run on the source), and what tag to - # apply to the built image when it is pushed to Google Container Registry. - # Fields can include the following variables which will be expanded when the - # build is created: - # - $PROJECT_ID: the project ID of the build. - # - $BUILD_ID: the autogenerated ID of the build. - # - $REPO_NAME: the source repository name specified by RepoSource. - # - $BRANCH_NAME: the branch name specified by RepoSource. - # - $TAG_NAME: the tag name specified by RepoSource. - # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or - # resolved from the specified branch or tag. - # Corresponds to the JSON property `build` - # @return [Google::Apis::CloudbuildV1::Build] - attr_accessor :build - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @description = args[:description] if args.key?(:description) - @trigger_template = args[:trigger_template] if args.key?(:trigger_template) - @disabled = args[:disabled] if args.key?(:disabled) - @create_time = args[:create_time] if args.key?(:create_time) - @filename = args[:filename] if args.key?(:filename) - @build = args[:build] if args.key?(:build) - end - end - - # BuiltImage describes an image built by the pipeline. - class BuiltImage - include Google::Apis::Core::Hashable - - # Docker Registry 2.0 digest. - # Corresponds to the JSON property `digest` - # @return [String] - attr_accessor :digest - - # Name used to push the container image to Google Container Registry, as - # presented to `docker push`. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @digest = args[:digest] if args.key?(:digest) - @name = args[:name] if args.key?(:name) - end - end - - # Container message for hash values. - class HashProp - include Google::Apis::Core::Hashable - - # The hash value. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - # The type of hash that was performed. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @value = args[:value] if args.key?(:value) - @type = args[:type] if args.key?(:type) - end - end - - # The request message for Operations.CancelOperation. - class CancelOperationRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # StorageSource describes the location of the source in an archive file in - # Google Cloud Storage. - class StorageSource - include Google::Apis::Core::Hashable - - # Google Cloud Storage bucket containing source (see - # [Bucket Name - # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) - # ). - # Corresponds to the JSON property `bucket` - # @return [String] - attr_accessor :bucket - - # Google Cloud Storage generation for the object. If the generation is - # omitted, the latest generation will be used. - # Corresponds to the JSON property `generation` - # @return [String] - attr_accessor :generation - - # Google Cloud Storage object containing source. - # This object must be a gzipped archive file (.tar.gz) containing source to - # build. - # Corresponds to the JSON property `object` - # @return [String] - attr_accessor :object - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bucket = args[:bucket] if args.key?(:bucket) - @generation = args[:generation] if args.key?(:generation) - @object = args[:object] if args.key?(:object) - end - end - - # Results describes the artifacts created by the build pipeline. - class Results - include Google::Apis::Core::Hashable - - # Images that were built as a part of the build. - # Corresponds to the JSON property `images` - # @return [Array] - attr_accessor :images - - # List of build step digests, in order corresponding to build step indices. - # Corresponds to the JSON property `buildStepImages` - # @return [Array] - attr_accessor :build_step_images - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @images = args[:images] if args.key?(:images) - @build_step_images = args[:build_step_images] if args.key?(:build_step_images) - end - end - - # A build resource in the Container Builder API. - # At a high level, a Build describes where to find source code, how to build - # it (for example, the builder image to run on the source), and what tag to - # apply to the built image when it is pushed to Google Container Registry. - # Fields can include the following variables which will be expanded when the - # build is created: - # - $PROJECT_ID: the project ID of the build. - # - $BUILD_ID: the autogenerated ID of the build. - # - $REPO_NAME: the source repository name specified by RepoSource. - # - $BRANCH_NAME: the branch name specified by RepoSource. - # - $TAG_NAME: the tag name specified by RepoSource. - # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or - # resolved from the specified branch or tag. - class Build - include Google::Apis::Core::Hashable - - # Unique identifier of the build. - # @OutputOnly - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Provenance of the source. Ways to find the original source, or verify that - # some source was used for this build. - # Corresponds to the JSON property `sourceProvenance` - # @return [Google::Apis::CloudbuildV1::SourceProvenance] - attr_accessor :source_provenance - - # Results describes the artifacts created by the build pipeline. - # Corresponds to the JSON property `results` - # @return [Google::Apis::CloudbuildV1::Results] - attr_accessor :results - - # Status of the build. - # @OutputOnly - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # Optional arguments to enable specific features of builds. - # Corresponds to the JSON property `options` - # @return [Google::Apis::CloudbuildV1::BuildOptions] - attr_accessor :options - - # Time at which execution of the build was finished. - # The difference between finish_time and start_time is the duration of the - # build's execution. - # @OutputOnly - # Corresponds to the JSON property `finishTime` - # @return [String] - attr_accessor :finish_time - - # Amount of time that this build should be allowed to run, to second - # granularity. If this amount of time elapses, work on the build will cease - # and the build status will be TIMEOUT. - # Default time is ten minutes. - # Corresponds to the JSON property `timeout` - # @return [String] - attr_accessor :timeout - - # Describes the operations to be performed on the workspace. - # Corresponds to the JSON property `steps` - # @return [Array] - attr_accessor :steps - - # Source describes the location of the source in a supported storage - # service. - # Corresponds to the JSON property `source` - # @return [Google::Apis::CloudbuildV1::Source] - attr_accessor :source - - # Time at which the request to create the build was received. - # @OutputOnly - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # URL to logs for this build in Google Cloud Logging. - # @OutputOnly - # Corresponds to the JSON property `logUrl` - # @return [String] - attr_accessor :log_url - - # Customer-readable message about the current status. - # @OutputOnly - # Corresponds to the JSON property `statusDetail` - # @return [String] - attr_accessor :status_detail - - # A list of images to be pushed upon the successful completion of all build - # steps. - # The images will be pushed using the builder service account's credentials. - # The digests of the pushed images will be stored in the Build resource's - # results field. - # If any of the images fail to be pushed, the build is marked FAILURE. - # Corresponds to the JSON property `images` - # @return [Array] - attr_accessor :images - - # Time at which execution of the build was started. - # @OutputOnly - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # The ID of the BuildTrigger that triggered this build, if it was - # triggered automatically. - # @OutputOnly - # Corresponds to the JSON property `buildTriggerId` - # @return [String] - attr_accessor :build_trigger_id - - # Google Cloud Storage bucket where logs should be written (see - # [Bucket Name - # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) - # ). - # Logs file names will be of the format `$`logs_bucket`/log-$`build_id`.txt`. - # Corresponds to the JSON property `logsBucket` - # @return [String] - attr_accessor :logs_bucket - - # ID of the project. - # @OutputOnly. - # Corresponds to the JSON property `projectId` - # @return [String] - attr_accessor :project_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @source_provenance = args[:source_provenance] if args.key?(:source_provenance) - @results = args[:results] if args.key?(:results) - @status = args[:status] if args.key?(:status) - @options = args[:options] if args.key?(:options) - @finish_time = args[:finish_time] if args.key?(:finish_time) - @timeout = args[:timeout] if args.key?(:timeout) - @steps = args[:steps] if args.key?(:steps) - @source = args[:source] if args.key?(:source) - @create_time = args[:create_time] if args.key?(:create_time) - @log_url = args[:log_url] if args.key?(:log_url) - @status_detail = args[:status_detail] if args.key?(:status_detail) - @images = args[:images] if args.key?(:images) - @start_time = args[:start_time] if args.key?(:start_time) - @build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id) - @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) - @project_id = args[:project_id] if args.key?(:project_id) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) end end @@ -663,32 +389,95 @@ module Google end end - # Request to cancel an ongoing build. - class CancelBuildRequest + # BuiltImage describes an image built by the pipeline. + class BuiltImage include Google::Apis::Core::Hashable + # Name used to push the container image to Google Container Registry, as + # presented to `docker push`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Docker Registry 2.0 digest. + # Corresponds to the JSON property `digest` + # @return [String] + attr_accessor :digest + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @name = args[:name] if args.key?(:name) + @digest = args[:digest] if args.key?(:digest) end end - # The response message for Operations.ListOperations. - class ListOperationsResponse + # BuildStep describes a step to perform in the build pipeline. + class BuildStep include Google::Apis::Core::Hashable - # The standard List next-page token. - # Corresponds to the JSON property `nextPageToken` + # The name of the container image that will run this particular build step. + # If the image is already available in the host's Docker daemon's cache, it + # will be run directly. If not, the host will attempt to pull the image + # first, using the builder service account's credentials if necessary. + # The Docker daemon's cache will already have the latest versions of all of + # the officially supported build steps + # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon + # will also have cached many of the layers for some popular images, like + # "ubuntu", "debian", but they will be refreshed at the time you attempt to + # use them. + # If you built an image in a previous build step, it will be stored in the + # host's Docker daemon's cache and is available to use as the name for a + # later build step. + # Corresponds to the JSON property `name` # @return [String] - attr_accessor :next_page_token + attr_accessor :name - # A list of operations that matches the specified filter in the request. - # Corresponds to the JSON property `operations` - # @return [Array] - attr_accessor :operations + # Optional entrypoint to be used instead of the build step image's default + # If unset, the image's default will be used. + # Corresponds to the JSON property `entrypoint` + # @return [String] + attr_accessor :entrypoint + + # Optional unique identifier for this build step, used in wait_for to + # reference this build step as a dependency. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Working directory (relative to project source root) to use when running + # this operation's container. + # Corresponds to the JSON property `dir` + # @return [String] + attr_accessor :dir + + # The ID(s) of the step(s) that this build step depends on. + # This build step will not start until all the build steps in wait_for + # have completed successfully. If wait_for is empty, this build step will + # start when all previous build steps in the Build.Steps list have completed + # successfully. + # Corresponds to the JSON property `waitFor` + # @return [Array] + attr_accessor :wait_for + + # A list of environment variable definitions to be used when running a step. + # The elements are of the form "KEY=VALUE" for the environment variable "KEY" + # being given the value "VALUE". + # Corresponds to the JSON property `env` + # @return [Array] + attr_accessor :env + + # A list of arguments that will be presented to the step when it is started. + # If the image used to run the step's container has an entrypoint, these args + # will be used as arguments to that entrypoint. If the image does not define + # an entrypoint, the first element in args will be used as the entrypoint, + # and the remainder will be used as arguments. + # Corresponds to the JSON property `args` + # @return [Array] + attr_accessor :args def initialize(**args) update!(**args) @@ -696,8 +485,83 @@ module Google # Update properties of this object def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @operations = args[:operations] if args.key?(:operations) + @name = args[:name] if args.key?(:name) + @entrypoint = args[:entrypoint] if args.key?(:entrypoint) + @id = args[:id] if args.key?(:id) + @dir = args[:dir] if args.key?(:dir) + @wait_for = args[:wait_for] if args.key?(:wait_for) + @env = args[:env] if args.key?(:env) + @args = args[:args] if args.key?(:args) + end + end + + # RepoSource describes the location of the source in a Google Cloud Source + # Repository. + class RepoSource + include Google::Apis::Core::Hashable + + # Name of the tag to build. + # Corresponds to the JSON property `tagName` + # @return [String] + attr_accessor :tag_name + + # Explicit commit SHA to build. + # Corresponds to the JSON property `commitSha` + # @return [String] + attr_accessor :commit_sha + + # ID of the project that owns the repo. If omitted, the project ID requesting + # the build is assumed. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # Name of the repo. If omitted, the name "default" is assumed. + # Corresponds to the JSON property `repoName` + # @return [String] + attr_accessor :repo_name + + # Name of the branch to build. + # Corresponds to the JSON property `branchName` + # @return [String] + attr_accessor :branch_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tag_name = args[:tag_name] if args.key?(:tag_name) + @commit_sha = args[:commit_sha] if args.key?(:commit_sha) + @project_id = args[:project_id] if args.key?(:project_id) + @repo_name = args[:repo_name] if args.key?(:repo_name) + @branch_name = args[:branch_name] if args.key?(:branch_name) + end + end + + # Container message for hash values. + class HashProp + include Google::Apis::Core::Hashable + + # The type of hash that was performed. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The hash value. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) end end @@ -721,36 +585,65 @@ module Google end end - # RepoSource describes the location of the source in a Google Cloud Source - # Repository. - class RepoSource + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` which can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting purpose. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status include Google::Apis::Core::Hashable - # Name of the repo. If omitted, the name "default" is assumed. - # Corresponds to the JSON property `repoName` + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` # @return [String] - attr_accessor :repo_name + attr_accessor :message - # Name of the tag to build. - # Corresponds to the JSON property `tagName` - # @return [String] - attr_accessor :tag_name + # A list of messages that carry the error details. There will be a + # common set of message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details - # ID of the project that owns the repo. If omitted, the project ID requesting - # the build is assumed. - # Corresponds to the JSON property `projectId` - # @return [String] - attr_accessor :project_id - - # Name of the branch to build. - # Corresponds to the JSON property `branchName` - # @return [String] - attr_accessor :branch_name - - # Explicit commit SHA to build. - # Corresponds to the JSON property `commitSha` - # @return [String] - attr_accessor :commit_sha + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code def initialize(**args) update!(**args) @@ -758,91 +651,9 @@ module Google # Update properties of this object def update!(**args) - @repo_name = args[:repo_name] if args.key?(:repo_name) - @tag_name = args[:tag_name] if args.key?(:tag_name) - @project_id = args[:project_id] if args.key?(:project_id) - @branch_name = args[:branch_name] if args.key?(:branch_name) - @commit_sha = args[:commit_sha] if args.key?(:commit_sha) - end - end - - # BuildStep describes a step to perform in the build pipeline. - class BuildStep - include Google::Apis::Core::Hashable - - # Optional unique identifier for this build step, used in wait_for to - # reference this build step as a dependency. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # A list of environment variable definitions to be used when running a step. - # The elements are of the form "KEY=VALUE" for the environment variable "KEY" - # being given the value "VALUE". - # Corresponds to the JSON property `env` - # @return [Array] - attr_accessor :env - - # The ID(s) of the step(s) that this build step depends on. - # This build step will not start until all the build steps in wait_for - # have completed successfully. If wait_for is empty, this build step will - # start when all previous build steps in the Build.Steps list have completed - # successfully. - # Corresponds to the JSON property `waitFor` - # @return [Array] - attr_accessor :wait_for - - # A list of arguments that will be presented to the step when it is started. - # If the image used to run the step's container has an entrypoint, these args - # will be used as arguments to that entrypoint. If the image does not define - # an entrypoint, the first element in args will be used as the entrypoint, - # and the remainder will be used as arguments. - # Corresponds to the JSON property `args` - # @return [Array] - attr_accessor :args - - # Optional entrypoint to be used instead of the build step image's default - # If unset, the image's default will be used. - # Corresponds to the JSON property `entrypoint` - # @return [String] - attr_accessor :entrypoint - - # The name of the container image that will run this particular build step. - # If the image is already available in the host's Docker daemon's cache, it - # will be run directly. If not, the host will attempt to pull the image - # first, using the builder service account's credentials if necessary. - # The Docker daemon's cache will already have the latest versions of all of - # the officially supported build steps - # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon - # will also have cached many of the layers for some popular images, like - # "ubuntu", "debian", but they will be refreshed at the time you attempt to - # use them. - # If you built an image in a previous build step, it will be stored in the - # host's Docker daemon's cache and is available to use as the name for a - # later build step. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Working directory (relative to project source root) to use when running - # this operation's container. - # Corresponds to the JSON property `dir` - # @return [String] - attr_accessor :dir - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @env = args[:env] if args.key?(:env) - @wait_for = args[:wait_for] if args.key?(:wait_for) - @args = args[:args] if args.key?(:args) - @entrypoint = args[:entrypoint] if args.key?(:entrypoint) - @name = args[:name] if args.key?(:name) - @dir = args[:dir] if args.key?(:dir) + @message = args[:message] if args.key?(:message) + @details = args[:details] if args.key?(:details) + @code = args[:code] if args.key?(:code) end end @@ -865,19 +676,62 @@ module Google end end - # Optional arguments to enable specific features of builds. - class BuildOptions + # Configuration for an automated build in response to source repository + # changes. + class BuildTrigger include Google::Apis::Core::Hashable - # Requested hash for SourceProvenance. - # Corresponds to the JSON property `sourceProvenanceHash` - # @return [Array] - attr_accessor :source_provenance_hash - - # Requested verifiability options. - # Corresponds to the JSON property `requestedVerifyOption` + # Time when the trigger was created. + # @OutputOnly + # Corresponds to the JSON property `createTime` # @return [String] - attr_accessor :requested_verify_option + attr_accessor :create_time + + # If true, the trigger will never result in a build. + # Corresponds to the JSON property `disabled` + # @return [Boolean] + attr_accessor :disabled + alias_method :disabled?, :disabled + + # RepoSource describes the location of the source in a Google Cloud Source + # Repository. + # Corresponds to the JSON property `triggerTemplate` + # @return [Google::Apis::CloudbuildV1::RepoSource] + attr_accessor :trigger_template + + # Path, from the source root, to a file whose contents is used for the + # template. + # Corresponds to the JSON property `filename` + # @return [String] + attr_accessor :filename + + # Unique identifier of the trigger. + # @OutputOnly + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A build resource in the Container Builder API. + # At a high level, a Build describes where to find source code, how to build + # it (for example, the builder image to run on the source), and what tag to + # apply to the built image when it is pushed to Google Container Registry. + # Fields can include the following variables which will be expanded when the + # build is created: + # - $PROJECT_ID: the project ID of the build. + # - $BUILD_ID: the autogenerated ID of the build. + # - $REPO_NAME: the source repository name specified by RepoSource. + # - $BRANCH_NAME: the branch name specified by RepoSource. + # - $TAG_NAME: the tag name specified by RepoSource. + # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or + # resolved from the specified branch or tag. + # Corresponds to the JSON property `build` + # @return [Google::Apis::CloudbuildV1::Build] + attr_accessor :build + + # Human-readable description of this trigger. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description def initialize(**args) update!(**args) @@ -885,24 +739,172 @@ module Google # Update properties of this object def update!(**args) - @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash) - @requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option) + @create_time = args[:create_time] if args.key?(:create_time) + @disabled = args[:disabled] if args.key?(:disabled) + @trigger_template = args[:trigger_template] if args.key?(:trigger_template) + @filename = args[:filename] if args.key?(:filename) + @id = args[:id] if args.key?(:id) + @build = args[:build] if args.key?(:build) + @description = args[:description] if args.key?(:description) end end - # Response including listed builds. - class ListBuildsResponse + # A build resource in the Container Builder API. + # At a high level, a Build describes where to find source code, how to build + # it (for example, the builder image to run on the source), and what tag to + # apply to the built image when it is pushed to Google Container Registry. + # Fields can include the following variables which will be expanded when the + # build is created: + # - $PROJECT_ID: the project ID of the build. + # - $BUILD_ID: the autogenerated ID of the build. + # - $REPO_NAME: the source repository name specified by RepoSource. + # - $BRANCH_NAME: the branch name specified by RepoSource. + # - $TAG_NAME: the tag name specified by RepoSource. + # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or + # resolved from the specified branch or tag. + class Build include Google::Apis::Core::Hashable - # Token to receive the next page of results. - # Corresponds to the JSON property `nextPageToken` + # Time at which the request to create the build was received. + # @OutputOnly + # Corresponds to the JSON property `createTime` # @return [String] - attr_accessor :next_page_token + attr_accessor :create_time - # Builds will be sorted by create_time, descending. - # Corresponds to the JSON property `builds` - # @return [Array] - attr_accessor :builds + # Provenance of the source. Ways to find the original source, or verify that + # some source was used for this build. + # Corresponds to the JSON property `sourceProvenance` + # @return [Google::Apis::CloudbuildV1::SourceProvenance] + attr_accessor :source_provenance + + # A list of images to be pushed upon the successful completion of all build + # steps. + # The images will be pushed using the builder service account's credentials. + # The digests of the pushed images will be stored in the Build resource's + # results field. + # If any of the images fail to be pushed, the build is marked FAILURE. + # Corresponds to the JSON property `images` + # @return [Array] + attr_accessor :images + + # ID of the project. + # @OutputOnly. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # URL to logs for this build in Google Cloud Logging. + # @OutputOnly + # Corresponds to the JSON property `logUrl` + # @return [String] + attr_accessor :log_url + + # Time at which execution of the build was finished. + # The difference between finish_time and start_time is the duration of the + # build's execution. + # @OutputOnly + # Corresponds to the JSON property `finishTime` + # @return [String] + attr_accessor :finish_time + + # Source describes the location of the source in a supported storage + # service. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudbuildV1::Source] + attr_accessor :source + + # Optional arguments to enable specific features of builds. + # Corresponds to the JSON property `options` + # @return [Google::Apis::CloudbuildV1::BuildOptions] + attr_accessor :options + + # Customer-readable message about the current status. + # @OutputOnly + # Corresponds to the JSON property `statusDetail` + # @return [String] + attr_accessor :status_detail + + # Status of the build. + # @OutputOnly + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Amount of time that this build should be allowed to run, to second + # granularity. If this amount of time elapses, work on the build will cease + # and the build status will be TIMEOUT. + # Default time is ten minutes. + # Corresponds to the JSON property `timeout` + # @return [String] + attr_accessor :timeout + + # Results describes the artifacts created by the build pipeline. + # Corresponds to the JSON property `results` + # @return [Google::Apis::CloudbuildV1::Results] + attr_accessor :results + + # Google Cloud Storage bucket where logs should be written (see + # [Bucket Name + # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements) + # ). + # Logs file names will be of the format `$`logs_bucket`/log-$`build_id`.txt`. + # Corresponds to the JSON property `logsBucket` + # @return [String] + attr_accessor :logs_bucket + + # Describes the operations to be performed on the workspace. + # Corresponds to the JSON property `steps` + # @return [Array] + attr_accessor :steps + + # The ID of the BuildTrigger that triggered this build, if it was + # triggered automatically. + # @OutputOnly + # Corresponds to the JSON property `buildTriggerId` + # @return [String] + attr_accessor :build_trigger_id + + # Unique identifier of the build. + # @OutputOnly + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Time at which execution of the build was started. + # @OutputOnly + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @source_provenance = args[:source_provenance] if args.key?(:source_provenance) + @images = args[:images] if args.key?(:images) + @project_id = args[:project_id] if args.key?(:project_id) + @log_url = args[:log_url] if args.key?(:log_url) + @finish_time = args[:finish_time] if args.key?(:finish_time) + @source = args[:source] if args.key?(:source) + @options = args[:options] if args.key?(:options) + @status_detail = args[:status_detail] if args.key?(:status_detail) + @status = args[:status] if args.key?(:status) + @timeout = args[:timeout] if args.key?(:timeout) + @results = args[:results] if args.key?(:results) + @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) + @steps = args[:steps] if args.key?(:steps) + @build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id) + @id = args[:id] if args.key?(:id) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Request to cancel an ongoing build. + class CancelBuildRequest + include Google::Apis::Core::Hashable def initialize(**args) update!(**args) @@ -910,8 +912,6 @@ module Google # Update properties of this object def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @builds = args[:builds] if args.key?(:builds) end end end diff --git a/generated/google/apis/cloudbuild_v1/representations.rb b/generated/google/apis/cloudbuild_v1/representations.rb index f2583eb51..b654e1ad5 100644 --- a/generated/google/apis/cloudbuild_v1/representations.rb +++ b/generated/google/apis/cloudbuild_v1/representations.rb @@ -22,13 +22,13 @@ module Google module Apis module CloudbuildV1 - class Status + class ListBuildsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class BuildOperationMetadata + class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -40,37 +40,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class SourceProvenance - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Operation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BuildTrigger - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BuiltImage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class HashProp - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CancelOperationRequest + class BuildOptions class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -88,7 +58,25 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Build + class BuildOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceProvenance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -100,25 +88,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class CancelBuildRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListOperationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileHashes - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepoSource + class BuiltImage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -130,37 +100,68 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Empty + class RepoSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class BuildOptions + class HashProp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class ListBuildsResponse + class FileHashes class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BuildTrigger + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Build + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelBuildRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListBuildsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :details, as: 'details' - property :message, as: 'message' + property :next_page_token, as: 'nextPageToken' + collection :builds, as: 'builds', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation + end end - class BuildOperationMetadata + class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::CloudbuildV1::Operation, decorator: Google::Apis::CloudbuildV1::Operation::Representation end end @@ -175,64 +176,11 @@ module Google end end - class SourceProvenance - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :resolved_repo_source, as: 'resolvedRepoSource', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation - - property :resolved_storage_source, as: 'resolvedStorageSource', class: Google::Apis::CloudbuildV1::StorageSource, decorator: Google::Apis::CloudbuildV1::StorageSource::Representation - - hash :file_hashes, as: 'fileHashes', class: Google::Apis::CloudbuildV1::FileHashes, decorator: Google::Apis::CloudbuildV1::FileHashes::Representation - - end - end - - class Operation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :error, as: 'error', class: Google::Apis::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation - - property :done, as: 'done' - hash :metadata, as: 'metadata' - hash :response, as: 'response' - property :name, as: 'name' - end - end - - class BuildTrigger - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :description, as: 'description' - property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation - - property :disabled, as: 'disabled' - property :create_time, as: 'createTime' - property :filename, as: 'filename' - property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation - - end - end - - class BuiltImage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :digest, as: 'digest' - property :name, as: 'name' - end - end - - class HashProp - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :value, :base64 => true, as: 'value' - property :type, as: 'type' - end - end - - class CancelOperationRequest + class BuildOptions # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :source_provenance_hash, as: 'sourceProvenanceHash' + property :requested_verify_option, as: 'requestedVerifyOption' end end @@ -240,8 +188,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :bucket, as: 'bucket' - property :generation, as: 'generation' property :object, as: 'object' + property :generation, as: 'generation' end end @@ -254,31 +202,41 @@ module Google end end - class Build + class BuildOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation + property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation - property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation + end + end - property :status, as: 'status' - property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation + class SourceProvenance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :file_hashes, as: 'fileHashes', class: Google::Apis::CloudbuildV1::FileHashes, decorator: Google::Apis::CloudbuildV1::FileHashes::Representation - property :finish_time, as: 'finishTime' - property :timeout, as: 'timeout' - collection :steps, as: 'steps', class: Google::Apis::CloudbuildV1::BuildStep, decorator: Google::Apis::CloudbuildV1::BuildStep::Representation + property :resolved_repo_source, as: 'resolvedRepoSource', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation - property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation + property :resolved_storage_source, as: 'resolvedStorageSource', class: Google::Apis::CloudbuildV1::StorageSource, decorator: Google::Apis::CloudbuildV1::StorageSource::Representation - property :create_time, as: 'createTime' - property :log_url, as: 'logUrl' - property :status_detail, as: 'statusDetail' - collection :images, as: 'images' - property :start_time, as: 'startTime' - property :build_trigger_id, as: 'buildTriggerId' - property :logs_bucket, as: 'logsBucket' - property :project_id, as: 'projectId' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + hash :response, as: 'response' + property :name, as: 'name' + property :error, as: 'error', class: Google::Apis::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation + + hash :metadata, as: 'metadata' end end @@ -290,18 +248,43 @@ module Google end end - class CancelBuildRequest + class BuiltImage # @private class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :digest, as: 'digest' end end - class ListOperationsResponse + class BuildStep # @private class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::CloudbuildV1::Operation, decorator: Google::Apis::CloudbuildV1::Operation::Representation + property :name, as: 'name' + property :entrypoint, as: 'entrypoint' + property :id, as: 'id' + property :dir, as: 'dir' + collection :wait_for, as: 'waitFor' + collection :env, as: 'env' + collection :args, as: 'args' + end + end + class RepoSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tag_name, as: 'tagName' + property :commit_sha, as: 'commitSha' + property :project_id, as: 'projectId' + property :repo_name, as: 'repoName' + property :branch_name, as: 'branchName' + end + end + + class HashProp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + property :value, :base64 => true, as: 'value' end end @@ -313,27 +296,12 @@ module Google end end - class RepoSource + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation - property :repo_name, as: 'repoName' - property :tag_name, as: 'tagName' - property :project_id, as: 'projectId' - property :branch_name, as: 'branchName' - property :commit_sha, as: 'commitSha' - end - end - - class BuildStep - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - collection :env, as: 'env' - collection :wait_for, as: 'waitFor' - collection :args, as: 'args' - property :entrypoint, as: 'entrypoint' - property :name, as: 'name' - property :dir, as: 'dir' + property :message, as: 'message' + collection :details, as: 'details' + property :code, as: 'code' end end @@ -343,20 +311,52 @@ module Google end end - class BuildOptions + class BuildTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :source_provenance_hash, as: 'sourceProvenanceHash' - property :requested_verify_option, as: 'requestedVerifyOption' + property :create_time, as: 'createTime' + property :disabled, as: 'disabled' + property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation + + property :filename, as: 'filename' + property :id, as: 'id' + property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation + + property :description, as: 'description' end end - class ListBuildsResponse + class Build # @private class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :builds, as: 'builds', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation + property :create_time, as: 'createTime' + property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation + collection :images, as: 'images' + property :project_id, as: 'projectId' + property :log_url, as: 'logUrl' + property :finish_time, as: 'finishTime' + property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation + + property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation + + property :status_detail, as: 'statusDetail' + property :status, as: 'status' + property :timeout, as: 'timeout' + property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation + + property :logs_bucket, as: 'logsBucket' + collection :steps, as: 'steps', class: Google::Apis::CloudbuildV1::BuildStep, decorator: Google::Apis::CloudbuildV1::BuildStep::Representation + + property :build_trigger_id, as: 'buildTriggerId' + property :id, as: 'id' + property :start_time, as: 'startTime' + end + end + + class CancelBuildRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation end end end diff --git a/generated/google/apis/cloudbuild_v1/service.rb b/generated/google/apis/cloudbuild_v1/service.rb index 136dd74fc..d1e6dbb6e 100644 --- a/generated/google/apis/cloudbuild_v1/service.rb +++ b/generated/google/apis/cloudbuild_v1/service.rb @@ -46,224 +46,17 @@ module Google super('https://cloudbuild.googleapis.com/', '') end - # Creates a new BuildTrigger. - # This API is experimental. - # @param [String] project_id - # ID of the project for which to configure automatic builds. - # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::BuildTrigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_trigger(project_id, build_trigger_object = nil, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/projects/{projectId}/triggers', options) - command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation - command.request_object = build_trigger_object - command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation - command.response_class = Google::Apis::CloudbuildV1::BuildTrigger - command.params['projectId'] = project_id unless project_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Gets information about a BuildTrigger. - # This API is experimental. - # @param [String] project_id - # ID of the project that owns the trigger. - # @param [String] trigger_id - # ID of the BuildTrigger to get. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::BuildTrigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_trigger(project_id, trigger_id, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/projects/{projectId}/triggers/{triggerId}', options) - command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation - command.response_class = Google::Apis::CloudbuildV1::BuildTrigger - command.params['projectId'] = project_id unless project_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Lists existing BuildTrigger. - # This API is experimental. - # @param [String] project_id - # ID of the project for which to list BuildTriggers. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::ListBuildTriggersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::ListBuildTriggersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_triggers(project_id, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/projects/{projectId}/triggers', options) - command.response_representation = Google::Apis::CloudbuildV1::ListBuildTriggersResponse::Representation - command.response_class = Google::Apis::CloudbuildV1::ListBuildTriggersResponse - command.params['projectId'] = project_id unless project_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Deletes an BuildTrigger by its project ID and trigger ID. - # This API is experimental. - # @param [String] project_id - # ID of the project that owns the trigger. - # @param [String] trigger_id - # ID of the BuildTrigger to delete. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_trigger(project_id, trigger_id, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1/projects/{projectId}/triggers/{triggerId}', options) - command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation - command.response_class = Google::Apis::CloudbuildV1::Empty - command.params['projectId'] = project_id unless project_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Updates an BuildTrigger by its project ID and trigger ID. - # This API is experimental. - # @param [String] project_id - # ID of the project that owns the trigger. - # @param [String] trigger_id - # ID of the BuildTrigger to update. - # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::BuildTrigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_trigger(project_id, trigger_id, build_trigger_object = nil, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1/projects/{projectId}/triggers/{triggerId}', options) - command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation - command.request_object = build_trigger_object - command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation - command.response_class = Google::Apis::CloudbuildV1::BuildTrigger - command.params['projectId'] = project_id unless project_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Starts a build with the specified configuration. - # The long-running Operation returned by this method will include the ID of - # the build, which can be passed to GetBuild to determine its status (e.g., - # success or failure). - # @param [String] project_id - # ID of the project. - # @param [Google::Apis::CloudbuildV1::Build] build_object - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_build(project_id, build_object = nil, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options) - command.request_representation = Google::Apis::CloudbuildV1::Build::Representation - command.request_object = build_object - command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation - command.response_class = Google::Apis::CloudbuildV1::Operation - command.params['projectId'] = project_id unless project_id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Returns information about a previously requested build. - # The Build that is returned includes its status (e.g., success or failure, - # or in-progress), and timing information. + # Cancels a requested build in progress. # @param [String] project_id # ID of the project. # @param [String] id # ID of the build. + # @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -276,14 +69,51 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_build(project_id, id, quota_user: nil, fields: nil, options: nil, &block) + def cancel_build(project_id, id, cancel_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:cancel', options) + command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation + command.request_object = cancel_build_request_object + command.response_representation = Google::Apis::CloudbuildV1::Build::Representation + command.response_class = Google::Apis::CloudbuildV1::Build + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns information about a previously requested build. + # The Build that is returned includes its status (e.g., success or failure, + # or in-progress), and timing information. + # @param [String] project_id + # ID of the project. + # @param [String] id + # ID of the build. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Build] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_build(project_id, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds/{id}', options) command.response_representation = Google::Apis::CloudbuildV1::Build::Representation command.response_class = Google::Apis::CloudbuildV1::Build command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -292,17 +122,17 @@ module Google # successfully or unsuccessfully. # @param [String] project_id # ID of the project. + # @param [String] page_token + # Token to provide to skip to a particular spot in the list. # @param [Fixnum] page_size # Number of results to return in the list. # @param [String] filter # The raw filter text to constrain the results. - # @param [String] page_token - # Token to provide to skip to a particular spot in the list. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -315,65 +145,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_builds(project_id, page_size: nil, filter: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block) + def list_project_builds(project_id, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds', options) command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse command.params['projectId'] = project_id unless project_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['filter'] = filter unless filter.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Cancels a requested build in progress. + # Starts a build with the specified configuration. + # The long-running Operation returned by this method will include the ID of + # the build, which can be passed to GetBuild to determine its status (e.g., + # success or failure). # @param [String] project_id # ID of the project. - # @param [String] id - # ID of the build. - # @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_request_object + # @param [Google::Apis::CloudbuildV1::Build] build_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudbuildV1::Build] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_build(project_id, id, cancel_build_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:cancel', options) - command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation - command.request_object = cancel_build_request_object - command.response_representation = Google::Apis::CloudbuildV1::Build::Representation - command.response_class = Google::Apis::CloudbuildV1::Build - command.params['projectId'] = project_id unless project_id.nil? - command.params['id'] = id unless id.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['fields'] = fields unless fields.nil? - execute_or_queue_command(command, &block) - end - - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. - # @param [String] name - # The name of the operation resource. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -386,55 +182,185 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_operation(name, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}', options) + def create_project_build(project_id, build_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options) + command.request_representation = Google::Apis::CloudbuildV1::Build::Representation + command.request_object = build_object command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::Operation - command.params['name'] = name unless name.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? + command.params['projectId'] = project_id unless project_id.nil? command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding below allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. - # @param [String] name - # The name of the operation collection. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] filter - # The standard list filter. - # @param [String] page_token - # The standard list page token. + # Creates a new BuildTrigger. + # This API is experimental. + # @param [String] project_id + # ID of the project for which to configure automatic builds. + # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudbuildV1::ListOperationsResponse] parsed result object + # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::CloudbuildV1::ListOperationsResponse] + # @return [Google::Apis::CloudbuildV1::BuildTrigger] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_operations(name, page_size: nil, filter: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}', options) - command.response_representation = Google::Apis::CloudbuildV1::ListOperationsResponse::Representation - command.response_class = Google::Apis::CloudbuildV1::ListOperationsResponse - command.params['name'] = name unless name.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? + def create_project_trigger(project_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/triggers', options) + command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation + command.request_object = build_trigger_object + command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation + command.response_class = Google::Apis::CloudbuildV1::BuildTrigger + command.params['projectId'] = project_id unless project_id.nil? command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an BuildTrigger by its project ID and trigger ID. + # This API is experimental. + # @param [String] project_id + # ID of the project that owns the trigger. + # @param [String] trigger_id + # ID of the BuildTrigger to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_trigger(project_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/projects/{projectId}/triggers/{triggerId}', options) + command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation + command.response_class = Google::Apis::CloudbuildV1::Empty + command.params['projectId'] = project_id unless project_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets information about a BuildTrigger. + # This API is experimental. + # @param [String] project_id + # ID of the project that owns the trigger. + # @param [String] trigger_id + # ID of the BuildTrigger to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::BuildTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_trigger(project_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/projects/{projectId}/triggers/{triggerId}', options) + command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation + command.response_class = Google::Apis::CloudbuildV1::BuildTrigger + command.params['projectId'] = project_id unless project_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists existing BuildTrigger. + # This API is experimental. + # @param [String] project_id + # ID of the project for which to list BuildTriggers. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::ListBuildTriggersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::ListBuildTriggersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_triggers(project_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/projects/{projectId}/triggers', options) + command.response_representation = Google::Apis::CloudbuildV1::ListBuildTriggersResponse::Representation + command.response_class = Google::Apis::CloudbuildV1::ListBuildTriggersResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an BuildTrigger by its project ID and trigger ID. + # This API is experimental. + # @param [String] project_id + # ID of the project that owns the trigger. + # @param [String] trigger_id + # ID of the BuildTrigger to update. + # @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::BuildTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_trigger(project_id, trigger_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/projects/{projectId}/triggers/{triggerId}', options) + command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation + command.request_object = build_trigger_object + command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation + command.response_class = Google::Apis::CloudbuildV1::BuildTrigger + command.params['projectId'] = project_id unless project_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -451,11 +377,11 @@ module Google # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -468,15 +394,89 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_operation(name, cancel_operation_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::CloudbuildV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation command.response_class = Google::Apis::CloudbuildV1::Empty command.params['name'] = name unless name.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding below allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. + # @param [String] name + # The name of the operation collection. + # @param [String] filter + # The standard list filter. + # @param [String] page_token + # The standard list page token. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operations(name, filter: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudbuildV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::CloudbuildV1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation + command.response_class = Google::Apis::CloudbuildV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index d7035b38a..aaf8850f5 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20170118' + REVISION = '20170122' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 534172d99..4213a0f6d 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20170118' + REVISION = '20170122' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dfareporting_v2_7.rb b/generated/google/apis/dfareporting_v2_7.rb new file mode 100644 index 000000000..83051d86f --- /dev/null +++ b/generated/google/apis/dfareporting_v2_7.rb @@ -0,0 +1,40 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/dfareporting_v2_7/service.rb' +require 'google/apis/dfareporting_v2_7/classes.rb' +require 'google/apis/dfareporting_v2_7/representations.rb' + +module Google + module Apis + # DCM/DFA Reporting And Trafficking API + # + # Manages your DoubleClick Campaign Manager ad campaigns and reports. + # + # @see https://developers.google.com/doubleclick-advertisers/ + module DfareportingV2_7 + VERSION = 'V2_7' + REVISION = '20161027' + + # Manage DoubleClick Digital Marketing conversions + AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' + + # View and manage DoubleClick for Advertisers reports + AUTH_DFAREPORTING = 'https://www.googleapis.com/auth/dfareporting' + + # View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns + AUTH_DFATRAFFICKING = 'https://www.googleapis.com/auth/dfatrafficking' + end + end +end diff --git a/generated/google/apis/dfareporting_v2_7/classes.rb b/generated/google/apis/dfareporting_v2_7/classes.rb new file mode 100644 index 000000000..9adcbbfe6 --- /dev/null +++ b/generated/google/apis/dfareporting_v2_7/classes.rb @@ -0,0 +1,11876 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV2_7 + + # Contains properties of a DCM account. + class Account + include Google::Apis::Core::Hashable + + # Account permissions assigned to this account. + # Corresponds to the JSON property `accountPermissionIds` + # @return [Array] + attr_accessor :account_permission_ids + + # Profile for this account. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountProfile` + # @return [String] + attr_accessor :account_profile + + # Whether this account is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Maximum number of active ads allowed for this account. + # Corresponds to the JSON property `activeAdsLimitTier` + # @return [String] + attr_accessor :active_ads_limit_tier + + # Whether to serve creatives with Active View tags. If disabled, viewability + # data will not be available for any impressions. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # User role permissions available to the user roles of this account. + # Corresponds to the JSON property `availablePermissionIds` + # @return [Array] + attr_accessor :available_permission_ids + + # ID of the country associated with this account. + # Corresponds to the JSON property `countryId` + # @return [String] + attr_accessor :country_id + + # ID of currency associated with this account. This is a required field. + # Acceptable values are: + # - "1" for USD + # - "2" for GBP + # - "3" for ESP + # - "4" for SEK + # - "5" for CAD + # - "6" for JPY + # - "7" for DEM + # - "8" for AUD + # - "9" for FRF + # - "10" for ITL + # - "11" for DKK + # - "12" for NOK + # - "13" for FIM + # - "14" for ZAR + # - "15" for IEP + # - "16" for NLG + # - "17" for EUR + # - "18" for KRW + # - "19" for TWD + # - "20" for SGD + # - "21" for CNY + # - "22" for HKD + # - "23" for NZD + # - "24" for MYR + # - "25" for BRL + # - "26" for PTE + # - "27" for MXP + # - "28" for CLP + # - "29" for TRY + # - "30" for ARS + # - "31" for PEN + # - "32" for ILS + # - "33" for CHF + # - "34" for VEF + # - "35" for COP + # - "36" for GTQ + # - "37" for PLN + # - "39" for INR + # - "40" for THB + # - "41" for IDR + # - "42" for CZK + # - "43" for RON + # - "44" for HUF + # - "45" for RUB + # - "46" for AED + # - "47" for BGN + # - "48" for HRK + # Corresponds to the JSON property `currencyId` + # @return [String] + attr_accessor :currency_id + + # Default placement dimensions for this account. + # Corresponds to the JSON property `defaultCreativeSizeId` + # @return [String] + attr_accessor :default_creative_size_id + + # Description of this account. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ID of this account. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#account". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Locale of this account. + # Acceptable values are: + # - "cs" (Czech) + # - "de" (German) + # - "en" (English) + # - "en-GB" (English United Kingdom) + # - "es" (Spanish) + # - "fr" (French) + # - "it" (Italian) + # - "ja" (Japanese) + # - "ko" (Korean) + # - "pl" (Polish) + # - "pt-BR" (Portuguese Brazil) + # - "ru" (Russian) + # - "sv" (Swedish) + # - "tr" (Turkish) + # - "zh-CN" (Chinese Simplified) + # - "zh-TW" (Chinese Traditional) + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # Maximum image size allowed for this account. + # Corresponds to the JSON property `maximumImageSize` + # @return [String] + attr_accessor :maximum_image_size + + # Name of this account. This is a required field, and must be less than 128 + # characters long and be globally unique. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether campaigns created in this account will be enabled for Nielsen OCR + # reach ratings by default. + # Corresponds to the JSON property `nielsenOcrEnabled` + # @return [Boolean] + attr_accessor :nielsen_ocr_enabled + alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled + + # Reporting Configuration + # Corresponds to the JSON property `reportsConfiguration` + # @return [Google::Apis::DfareportingV2_7::ReportsConfiguration] + attr_accessor :reports_configuration + + # Share Path to Conversion reports with Twitter. + # Corresponds to the JSON property `shareReportsWithTwitter` + # @return [Boolean] + attr_accessor :share_reports_with_twitter + alias_method :share_reports_with_twitter?, :share_reports_with_twitter + + # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 + # and 10240. + # Corresponds to the JSON property `teaserSizeLimit` + # @return [String] + attr_accessor :teaser_size_limit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permission_ids = args[:account_permission_ids] if args.key?(:account_permission_ids) + @account_profile = args[:account_profile] if args.key?(:account_profile) + @active = args[:active] if args.key?(:active) + @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) + @country_id = args[:country_id] if args.key?(:country_id) + @currency_id = args[:currency_id] if args.key?(:currency_id) + @default_creative_size_id = args[:default_creative_size_id] if args.key?(:default_creative_size_id) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @locale = args[:locale] if args.key?(:locale) + @maximum_image_size = args[:maximum_image_size] if args.key?(:maximum_image_size) + @name = args[:name] if args.key?(:name) + @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) + @reports_configuration = args[:reports_configuration] if args.key?(:reports_configuration) + @share_reports_with_twitter = args[:share_reports_with_twitter] if args.key?(:share_reports_with_twitter) + @teaser_size_limit = args[:teaser_size_limit] if args.key?(:teaser_size_limit) + end + end + + # Gets a summary of active ads in an account. + class AccountActiveAdSummary + include Google::Apis::Core::Hashable + + # ID of the account. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Ads that have been activated for the account + # Corresponds to the JSON property `activeAds` + # @return [String] + attr_accessor :active_ads + + # Maximum number of active ads allowed for the account. + # Corresponds to the JSON property `activeAdsLimitTier` + # @return [String] + attr_accessor :active_ads_limit_tier + + # Ads that can be activated for the account. + # Corresponds to the JSON property `availableAds` + # @return [String] + attr_accessor :available_ads + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountActiveAdSummary". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active_ads = args[:active_ads] if args.key?(:active_ads) + @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) + @available_ads = args[:available_ads] if args.key?(:available_ads) + @kind = args[:kind] if args.key?(:kind) + end + end + + # AccountPermissions contains information about a particular account permission. + # Some features of DCM require an account permission to be present in the + # account. + class AccountPermission + include Google::Apis::Core::Hashable + + # Account profiles associated with this account permission. + # Possible values are: + # - "ACCOUNT_PROFILE_BASIC" + # - "ACCOUNT_PROFILE_STANDARD" + # Corresponds to the JSON property `accountProfiles` + # @return [Array] + attr_accessor :account_profiles + + # ID of this account permission. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermission". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Administrative level required to enable this account permission. + # Corresponds to the JSON property `level` + # @return [String] + attr_accessor :level + + # Name of this account permission. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Permission group of this account permission. + # Corresponds to the JSON property `permissionGroupId` + # @return [String] + attr_accessor :permission_group_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_profiles = args[:account_profiles] if args.key?(:account_profiles) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @level = args[:level] if args.key?(:level) + @name = args[:name] if args.key?(:name) + @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) + end + end + + # AccountPermissionGroups contains a mapping of permission group IDs to names. A + # permission group is a grouping of account permissions. + class AccountPermissionGroup + include Google::Apis::Core::Hashable + + # ID of this account permission group. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this account permission group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Account Permission Group List Response + class AccountPermissionGroupsListResponse + include Google::Apis::Core::Hashable + + # Account permission group collection. + # Corresponds to the JSON property `accountPermissionGroups` + # @return [Array] + attr_accessor :account_permission_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permission_groups = args[:account_permission_groups] if args.key?(:account_permission_groups) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Account Permission List Response + class AccountPermissionsListResponse + include Google::Apis::Core::Hashable + + # Account permission collection. + # Corresponds to the JSON property `accountPermissions` + # @return [Array] + attr_accessor :account_permissions + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permissions = args[:account_permissions] if args.key?(:account_permissions) + @kind = args[:kind] if args.key?(:kind) + end + end + + # AccountUserProfiles contains properties of a DCM user profile. This resource + # is specifically for managing user profiles, whereas UserProfiles is for + # accessing the API. + class AccountUserProfile + include Google::Apis::Core::Hashable + + # Account ID of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this user profile is active. This defaults to false, and must be set + # true on insert for the user profile to be usable. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Object Filter. + # Corresponds to the JSON property `advertiserFilter` + # @return [Google::Apis::DfareportingV2_7::ObjectFilter] + attr_accessor :advertiser_filter + + # Object Filter. + # Corresponds to the JSON property `campaignFilter` + # @return [Google::Apis::DfareportingV2_7::ObjectFilter] + attr_accessor :campaign_filter + + # Comments for this user profile. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Email of the user profile. The email addresss must be linked to a Google + # Account. This field is required on insertion and is read-only after insertion. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # ID of the user profile. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountUserProfile". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Locale of the user profile. This is a required field. + # Acceptable values are: + # - "cs" (Czech) + # - "de" (German) + # - "en" (English) + # - "en-GB" (English United Kingdom) + # - "es" (Spanish) + # - "fr" (French) + # - "it" (Italian) + # - "ja" (Japanese) + # - "ko" (Korean) + # - "pl" (Polish) + # - "pt-BR" (Portuguese Brazil) + # - "ru" (Russian) + # - "sv" (Swedish) + # - "tr" (Turkish) + # - "zh-CN" (Chinese Simplified) + # - "zh-TW" (Chinese Traditional) + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # Name of the user profile. This is a required field. Must be less than 64 + # characters long, must be globally unique, and cannot contain whitespace or any + # of the following characters: "&;"#%,". + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Object Filter. + # Corresponds to the JSON property `siteFilter` + # @return [Google::Apis::DfareportingV2_7::ObjectFilter] + attr_accessor :site_filter + + # Subaccount ID of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Trafficker type of this user profile. + # Corresponds to the JSON property `traffickerType` + # @return [String] + attr_accessor :trafficker_type + + # User type of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `userAccessType` + # @return [String] + attr_accessor :user_access_type + + # Object Filter. + # Corresponds to the JSON property `userRoleFilter` + # @return [Google::Apis::DfareportingV2_7::ObjectFilter] + attr_accessor :user_role_filter + + # User role ID of the user profile. This is a required field. + # Corresponds to the JSON property `userRoleId` + # @return [String] + attr_accessor :user_role_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_filter = args[:advertiser_filter] if args.key?(:advertiser_filter) + @campaign_filter = args[:campaign_filter] if args.key?(:campaign_filter) + @comments = args[:comments] if args.key?(:comments) + @email = args[:email] if args.key?(:email) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @locale = args[:locale] if args.key?(:locale) + @name = args[:name] if args.key?(:name) + @site_filter = args[:site_filter] if args.key?(:site_filter) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @trafficker_type = args[:trafficker_type] if args.key?(:trafficker_type) + @user_access_type = args[:user_access_type] if args.key?(:user_access_type) + @user_role_filter = args[:user_role_filter] if args.key?(:user_role_filter) + @user_role_id = args[:user_role_id] if args.key?(:user_role_id) + end + end + + # Account User Profile List Response + class AccountUserProfilesListResponse + include Google::Apis::Core::Hashable + + # Account user profile collection. + # Corresponds to the JSON property `accountUserProfiles` + # @return [Array] + attr_accessor :account_user_profiles + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountUserProfilesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_user_profiles = args[:account_user_profiles] if args.key?(:account_user_profiles) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Account List Response + class AccountsListResponse + include Google::Apis::Core::Hashable + + # Account collection. + # Corresponds to the JSON property `accounts` + # @return [Array] + attr_accessor :accounts + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accounts = args[:accounts] if args.key?(:accounts) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents an activity group. + class Activities + include Google::Apis::Core::Hashable + + # List of activity filters. The dimension values need to be all either of type " + # dfa:activity" or "dfa:activityGroup". + # Corresponds to the JSON property `filters` + # @return [Array] + attr_accessor :filters + + # The kind of resource this is, in this case dfareporting#activities. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # List of names of floodlight activity metrics. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filters = args[:filters] if args.key?(:filters) + @kind = args[:kind] if args.key?(:kind) + @metric_names = args[:metric_names] if args.key?(:metric_names) + end + end + + # Contains properties of a DCM ad. + class Ad + include Google::Apis::Core::Hashable + + # Account ID of this ad. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this ad is active. When true, archived must be false. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Advertiser ID of this ad. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this ad is archived. When true, active must be false. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Audience segment ID that is being targeted for this ad. Applicable when type + # is AD_SERVING_STANDARD_AD. + # Corresponds to the JSON property `audienceSegmentId` + # @return [String] + attr_accessor :audience_segment_id + + # Campaign ID of this ad. This is a required field on insertion. + # Corresponds to the JSON property `campaignId` + # @return [String] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrl] + attr_accessor :click_through_url + + # Click Through URL Suffix settings. + # Corresponds to the JSON property `clickThroughUrlSuffixProperties` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties] + attr_accessor :click_through_url_suffix_properties + + # Comments for this ad. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + # DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on + # mobile devices or in mobile apps for regular or interstitial ads, respectively. + # APP and APP_INTERSTITIAL are only used for existing default ads. New mobile + # placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads + # created for those placements will be limited to those compatibility types. + # IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the + # VAST standard. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :create_info + + # Creative group assignments for this ad. Applicable when type is + # AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is + # allowed for a maximum of two assignments. + # Corresponds to the JSON property `creativeGroupAssignments` + # @return [Array] + attr_accessor :creative_group_assignments + + # Creative Rotation. + # Corresponds to the JSON property `creativeRotation` + # @return [Google::Apis::DfareportingV2_7::CreativeRotation] + attr_accessor :creative_rotation + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV2_7::DayPartTargeting] + attr_accessor :day_part_targeting + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + # Corresponds to the JSON property `defaultClickThroughEventTagProperties` + # @return [Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # Delivery Schedule. + # Corresponds to the JSON property `deliverySchedule` + # @return [Google::Apis::DfareportingV2_7::DeliverySchedule] + attr_accessor :delivery_schedule + + # Whether this ad is a dynamic click tracker. Applicable when type is + # AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only + # after insert. + # Corresponds to the JSON property `dynamicClickTracker` + # @return [Boolean] + attr_accessor :dynamic_click_tracker + alias_method :dynamic_click_tracker?, :dynamic_click_tracker + + # Date and time that this ad should stop serving. Must be later than the start + # time. This is a required field on insertion. + # Corresponds to the JSON property `endTime` + # @return [DateTime] + attr_accessor :end_time + + # Event tag overrides for this ad. + # Corresponds to the JSON property `eventTagOverrides` + # @return [Array] + attr_accessor :event_tag_overrides + + # Geographical Targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::DfareportingV2_7::GeoTargeting] + attr_accessor :geo_targeting + + # ID of this ad. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV2_7::KeyValueTargetingExpression] + attr_accessor :key_value_targeting_expression + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#ad". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language Targeting. + # Corresponds to the JSON property `languageTargeting` + # @return [Google::Apis::DfareportingV2_7::LanguageTargeting] + attr_accessor :language_targeting + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this ad. This is a required field and must be less than 256 characters + # long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Placement assignments for this ad. + # Corresponds to the JSON property `placementAssignments` + # @return [Array] + attr_accessor :placement_assignments + + # Remarketing List Targeting Expression. + # Corresponds to the JSON property `remarketingListExpression` + # @return [Google::Apis::DfareportingV2_7::ListTargetingExpression] + attr_accessor :remarketing_list_expression + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :size + + # Whether this ad is ssl compliant. This is a read-only field that is auto- + # generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether this ad requires ssl. This is a read-only field that is auto-generated + # when the ad is inserted or updated. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Date and time that this ad should start serving. If creating an ad, this field + # must be a time in the future. This is a required field on insertion. + # Corresponds to the JSON property `startTime` + # @return [DateTime] + attr_accessor :start_time + + # Subaccount ID of this ad. This is a read-only field that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Targeting template ID, used to apply preconfigured targeting information to + # this ad. This cannot be set while any of dayPartTargeting, geoTargeting, + # keyValueTargetingExpression, languageTargeting, remarketingListExpression, or + # technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. + # Corresponds to the JSON property `targetingTemplateId` + # @return [String] + attr_accessor :targeting_template_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV2_7::TechnologyTargeting] + attr_accessor :technology_targeting + + # Type of ad. This is a required field on insertion. Note that default ads ( + # AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @audience_segment_id = args[:audience_segment_id] if args.key?(:audience_segment_id) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) + @comments = args[:comments] if args.key?(:comments) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @create_info = args[:create_info] if args.key?(:create_info) + @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) + @creative_rotation = args[:creative_rotation] if args.key?(:creative_rotation) + @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) + @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) + @delivery_schedule = args[:delivery_schedule] if args.key?(:delivery_schedule) + @dynamic_click_tracker = args[:dynamic_click_tracker] if args.key?(:dynamic_click_tracker) + @end_time = args[:end_time] if args.key?(:end_time) + @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) + @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) + @kind = args[:kind] if args.key?(:kind) + @language_targeting = args[:language_targeting] if args.key?(:language_targeting) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @placement_assignments = args[:placement_assignments] if args.key?(:placement_assignments) + @remarketing_list_expression = args[:remarketing_list_expression] if args.key?(:remarketing_list_expression) + @size = args[:size] if args.key?(:size) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @start_time = args[:start_time] if args.key?(:start_time) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) + @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) + @type = args[:type] if args.key?(:type) + end + end + + # Ad Slot + class AdSlot + include Google::Apis::Core::Hashable + + # Comment for this ad slot. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # either on desktop, mobile devices or in mobile apps for regular or + # interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in + # mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads + # developed with the VAST standard. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # Height of this ad slot. + # Corresponds to the JSON property `height` + # @return [String] + attr_accessor :height + + # ID of the placement from an external platform that is linked to this ad slot. + # Corresponds to the JSON property `linkedPlacementId` + # @return [String] + attr_accessor :linked_placement_id + + # Name of this ad slot. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Payment source type of this ad slot. + # Corresponds to the JSON property `paymentSourceType` + # @return [String] + attr_accessor :payment_source_type + + # Primary ad slot of a roadblock inventory item. + # Corresponds to the JSON property `primary` + # @return [Boolean] + attr_accessor :primary + alias_method :primary?, :primary + + # Width of this ad slot. + # Corresponds to the JSON property `width` + # @return [String] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @comment = args[:comment] if args.key?(:comment) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @height = args[:height] if args.key?(:height) + @linked_placement_id = args[:linked_placement_id] if args.key?(:linked_placement_id) + @name = args[:name] if args.key?(:name) + @payment_source_type = args[:payment_source_type] if args.key?(:payment_source_type) + @primary = args[:primary] if args.key?(:primary) + @width = args[:width] if args.key?(:width) + end + end + + # Ad List Response + class AdsListResponse + include Google::Apis::Core::Hashable + + # Ad collection. + # Corresponds to the JSON property `ads` + # @return [Array] + attr_accessor :ads + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#adsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ads = args[:ads] if args.key?(:ads) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a DCM advertiser. + class Advertiser + include Google::Apis::Core::Hashable + + # Account ID of this advertiser.This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # ID of the advertiser group this advertiser belongs to. You can group + # advertisers for reporting purposes, allowing you to see aggregated information + # for all advertisers in each group. + # Corresponds to the JSON property `advertiserGroupId` + # @return [String] + attr_accessor :advertiser_group_id + + # Suffix added to click-through URL of ad creative associations under this + # advertiser. Must be less than 129 characters long. + # Corresponds to the JSON property `clickThroughUrlSuffix` + # @return [String] + attr_accessor :click_through_url_suffix + + # ID of the click-through event tag to apply by default to the landing pages of + # this advertiser's campaigns. + # Corresponds to the JSON property `defaultClickThroughEventTagId` + # @return [String] + attr_accessor :default_click_through_event_tag_id + + # Default email address used in sender field for tag emails. + # Corresponds to the JSON property `defaultEmail` + # @return [String] + attr_accessor :default_email + + # Floodlight configuration ID of this advertiser. The floodlight configuration + # ID will be created automatically, so on insert this field should be left blank. + # This field can be set to another advertiser's floodlight configuration ID in + # order to share that advertiser's floodlight configuration with this advertiser, + # so long as: + # - This advertiser's original floodlight configuration is not already + # associated with floodlight activities or floodlight activity groups. + # - This advertiser's original floodlight configuration is not already shared + # with another advertiser. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [String] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # ID of this advertiser. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiser". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this advertiser. This is a required field and must be less than 256 + # characters long and unique among advertisers of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Original floodlight configuration before any sharing occurred. Set the + # floodlightConfigurationId of this advertiser to + # originalFloodlightConfigurationId to unshare the advertiser's current + # floodlight configuration. You cannot unshare an advertiser's floodlight + # configuration if the shared configuration has activities associated with any + # campaign or placement. + # Corresponds to the JSON property `originalFloodlightConfigurationId` + # @return [String] + attr_accessor :original_floodlight_configuration_id + + # Status of this advertiser. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this advertiser.This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Suspension status of this advertiser. + # Corresponds to the JSON property `suspended` + # @return [Boolean] + attr_accessor :suspended + alias_method :suspended?, :suspended + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) + @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) + @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) + @default_email = args[:default_email] if args.key?(:default_email) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @original_floodlight_configuration_id = args[:original_floodlight_configuration_id] if args.key?(:original_floodlight_configuration_id) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @suspended = args[:suspended] if args.key?(:suspended) + end + end + + # Groups advertisers together so that reports can be generated for the entire + # group at once. + class AdvertiserGroup + include Google::Apis::Core::Hashable + + # Account ID of this advertiser group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # ID of this advertiser group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this advertiser group. This is a required field and must be less than + # 256 characters long and unique among advertiser groups of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Advertiser Group List Response + class AdvertiserGroupsListResponse + include Google::Apis::Core::Hashable + + # Advertiser group collection. + # Corresponds to the JSON property `advertiserGroups` + # @return [Array] + attr_accessor :advertiser_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_groups = args[:advertiser_groups] if args.key?(:advertiser_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Advertiser List Response + class AdvertisersListResponse + include Google::Apis::Core::Hashable + + # Advertiser collection. + # Corresponds to the JSON property `advertisers` + # @return [Array] + attr_accessor :advertisers + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertisersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertisers = args[:advertisers] if args.key?(:advertisers) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Audience Segment. + class AudienceSegment + include Google::Apis::Core::Hashable + + # Weight allocated to this segment. Must be between 1 and 1000. The weight + # assigned will be understood in proportion to the weights assigned to other + # segments in the same segment group. + # Corresponds to the JSON property `allocation` + # @return [Fixnum] + attr_accessor :allocation + + # ID of this audience segment. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Name of this audience segment. This is a required field and must be less than + # 65 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allocation = args[:allocation] if args.key?(:allocation) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + + # Audience Segment Group. + class AudienceSegmentGroup + include Google::Apis::Core::Hashable + + # Audience segments assigned to this group. The number of segments must be + # between 2 and 100. + # Corresponds to the JSON property `audienceSegments` + # @return [Array] + attr_accessor :audience_segments + + # ID of this audience segment group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Name of this audience segment group. This is a required field and must be less + # than 65 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audience_segments = args[:audience_segments] if args.key?(:audience_segments) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a browser that can be targeted by ads. + class Browser + include Google::Apis::Core::Hashable + + # ID referring to this grouping of browser and version numbers. This is the ID + # used for targeting. + # Corresponds to the JSON property `browserVersionId` + # @return [String] + attr_accessor :browser_version_id + + # DART ID of this browser. This is the ID used when generating reports. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#browser". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Major version number (leftmost number) of this browser. For example, for + # Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be + # used to target any version number, and a question mark (?) may be used to + # target cases where the version number cannot be identified. For example, + # Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* + # targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad + # server knows the browser is Firefox but can't tell which version it is. + # Corresponds to the JSON property `majorVersion` + # @return [String] + attr_accessor :major_version + + # Minor version number (number after first dot on left) of this browser. For + # example, for Chrome 5.0.375.86 beta, this field should be set to 0. An + # asterisk (*) may be used to target any version number, and a question mark (?) + # may be used to target cases where the version number cannot be identified. For + # example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. + # Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases + # where the ad server knows the browser is Firefox but can't tell which version + # it is. + # Corresponds to the JSON property `minorVersion` + # @return [String] + attr_accessor :minor_version + + # Name of this browser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browser_version_id = args[:browser_version_id] if args.key?(:browser_version_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @major_version = args[:major_version] if args.key?(:major_version) + @minor_version = args[:minor_version] if args.key?(:minor_version) + @name = args[:name] if args.key?(:name) + end + end + + # Browser List Response + class BrowsersListResponse + include Google::Apis::Core::Hashable + + # Browser collection. + # Corresponds to the JSON property `browsers` + # @return [Array] + attr_accessor :browsers + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#browsersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browsers = args[:browsers] if args.key?(:browsers) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of a DCM campaign. + class Campaign + include Google::Apis::Core::Hashable + + # Account ID of this campaign. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Additional creative optimization configurations for the campaign. + # Corresponds to the JSON property `additionalCreativeOptimizationConfigurations` + # @return [Array] + attr_accessor :additional_creative_optimization_configurations + + # Advertiser group ID of the associated advertiser. + # Corresponds to the JSON property `advertiserGroupId` + # @return [String] + attr_accessor :advertiser_group_id + + # Advertiser ID of this campaign. This is a required field. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this campaign has been archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Audience segment groups assigned to this campaign. Cannot have more than 300 + # segment groups. + # Corresponds to the JSON property `audienceSegmentGroups` + # @return [Array] + attr_accessor :audience_segment_groups + + # Billing invoice code included in the DCM client billing invoices associated + # with the campaign. + # Corresponds to the JSON property `billingInvoiceCode` + # @return [String] + attr_accessor :billing_invoice_code + + # Click Through URL Suffix settings. + # Corresponds to the JSON property `clickThroughUrlSuffixProperties` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties] + attr_accessor :click_through_url_suffix_properties + + # Arbitrary comments about this campaign. Must be less than 256 characters long. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :create_info + + # List of creative group IDs that are assigned to the campaign. + # Corresponds to the JSON property `creativeGroupIds` + # @return [Array] + attr_accessor :creative_group_ids + + # Creative optimization settings. + # Corresponds to the JSON property `creativeOptimizationConfiguration` + # @return [Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration] + attr_accessor :creative_optimization_configuration + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + # Corresponds to the JSON property `defaultClickThroughEventTagProperties` + # @return [Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # Date on which the campaign will stop running. On insert, the end date must be + # today or a future date. The end date must be later than or be the same as the + # start date. If, for example, you set 6/25/2015 as both the start and end dates, + # the effective campaign run date is just that day only, 6/25/2015. The hours, + # minutes, and seconds of the end date should not be set, as doing so will + # result in an error. This is a required field. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Overrides that can be used to activate or deactivate advertiser event tags. + # Corresponds to the JSON property `eventTagOverrides` + # @return [Array] + attr_accessor :event_tag_overrides + + # External ID for this campaign. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this campaign. This is a read-only auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaign". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV2_7::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Name of this campaign. This is a required field and must be less than 256 + # characters long and unique among campaigns of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether Nielsen reports are enabled for this campaign. + # Corresponds to the JSON property `nielsenOcrEnabled` + # @return [Boolean] + attr_accessor :nielsen_ocr_enabled + alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled + + # Date on which the campaign starts running. The start date can be any date. The + # hours, minutes, and seconds of the start date should not be set, as doing so + # will result in an error. This is a required field. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Subaccount ID of this campaign. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Campaign trafficker contact emails. + # Corresponds to the JSON property `traffickerEmails` + # @return [Array] + attr_accessor :trafficker_emails + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations) + @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @audience_segment_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups) + @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code) + @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) + @comment = args[:comment] if args.key?(:comment) + @create_info = args[:create_info] if args.key?(:create_info) + @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids) + @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration) + @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) + @end_date = args[:end_date] if args.key?(:end_date) + @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @name = args[:name] if args.key?(:name) + @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) + @start_date = args[:start_date] if args.key?(:start_date) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @trafficker_emails = args[:trafficker_emails] if args.key?(:trafficker_emails) + end + end + + # Identifies a creative which has been associated with a given campaign. + class CampaignCreativeAssociation + include Google::Apis::Core::Hashable + + # ID of the creative associated with the campaign. This is a required field. + # Corresponds to the JSON property `creativeId` + # @return [String] + attr_accessor :creative_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignCreativeAssociation". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Campaign Creative Association List Response + class CampaignCreativeAssociationsListResponse + include Google::Apis::Core::Hashable + + # Campaign creative association collection + # Corresponds to the JSON property `campaignCreativeAssociations` + # @return [Array] + attr_accessor :campaign_creative_associations + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignCreativeAssociationsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @campaign_creative_associations = args[:campaign_creative_associations] if args.key?(:campaign_creative_associations) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Campaign List Response + class CampaignsListResponse + include Google::Apis::Core::Hashable + + # Campaign collection. + # Corresponds to the JSON property `campaigns` + # @return [Array] + attr_accessor :campaigns + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @campaigns = args[:campaigns] if args.key?(:campaigns) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Describes a change that a user has made to a resource. + class ChangeLog + include Google::Apis::Core::Hashable + + # Account ID of the modified object. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Action which caused the change. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Time when the object was modified. + # Corresponds to the JSON property `changeTime` + # @return [DateTime] + attr_accessor :change_time + + # Field name of the object which changed. + # Corresponds to the JSON property `fieldName` + # @return [String] + attr_accessor :field_name + + # ID of this change log. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#changeLog". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # New value of the object field. + # Corresponds to the JSON property `newValue` + # @return [String] + attr_accessor :new_value + + # ID of the object of this change log. The object could be a campaign, placement, + # ad, or other type. + # Corresponds to the JSON property `objectId` + # @return [String] + attr_accessor :object_id_prop + + # Object type of the change log. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Old value of the object field. + # Corresponds to the JSON property `oldValue` + # @return [String] + attr_accessor :old_value + + # Subaccount ID of the modified object. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Transaction ID of this change log. When a single API call results in many + # changes, each change will have a separate ID in the change log but will share + # the same transactionId. + # Corresponds to the JSON property `transactionId` + # @return [String] + attr_accessor :transaction_id + + # ID of the user who modified the object. + # Corresponds to the JSON property `userProfileId` + # @return [String] + attr_accessor :user_profile_id + + # User profile name of the user who modified the object. + # Corresponds to the JSON property `userProfileName` + # @return [String] + attr_accessor :user_profile_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @action = args[:action] if args.key?(:action) + @change_time = args[:change_time] if args.key?(:change_time) + @field_name = args[:field_name] if args.key?(:field_name) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @new_value = args[:new_value] if args.key?(:new_value) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @object_type = args[:object_type] if args.key?(:object_type) + @old_value = args[:old_value] if args.key?(:old_value) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @transaction_id = args[:transaction_id] if args.key?(:transaction_id) + @user_profile_id = args[:user_profile_id] if args.key?(:user_profile_id) + @user_profile_name = args[:user_profile_name] if args.key?(:user_profile_name) + end + end + + # Change Log List Response + class ChangeLogsListResponse + include Google::Apis::Core::Hashable + + # Change log collection. + # Corresponds to the JSON property `changeLogs` + # @return [Array] + attr_accessor :change_logs + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#changeLogsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @change_logs = args[:change_logs] if args.key?(:change_logs) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # City List Response + class CitiesListResponse + include Google::Apis::Core::Hashable + + # City collection. + # Corresponds to the JSON property `cities` + # @return [Array] + attr_accessor :cities + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#citiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cities = args[:cities] if args.key?(:cities) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a city that can be targeted by ads. + class City + include Google::Apis::Core::Hashable + + # Country code of the country to which this city belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this city belongs. + # Corresponds to the JSON property `countryDartId` + # @return [String] + attr_accessor :country_dart_id + + # DART ID of this city. This is the ID used for targeting and generating reports. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#city". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro region code of the metro region (DMA) to which this city belongs. + # Corresponds to the JSON property `metroCode` + # @return [String] + attr_accessor :metro_code + + # ID of the metro region (DMA) to which this city belongs. + # Corresponds to the JSON property `metroDmaId` + # @return [String] + attr_accessor :metro_dma_id + + # Name of this city. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Region code of the region to which this city belongs. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + # DART ID of the region to which this city belongs. + # Corresponds to the JSON property `regionDartId` + # @return [String] + attr_accessor :region_dart_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @metro_code = args[:metro_code] if args.key?(:metro_code) + @metro_dma_id = args[:metro_dma_id] if args.key?(:metro_dma_id) + @name = args[:name] if args.key?(:name) + @region_code = args[:region_code] if args.key?(:region_code) + @region_dart_id = args[:region_dart_id] if args.key?(:region_dart_id) + end + end + + # Creative Click Tag. + class ClickTag + include Google::Apis::Core::Hashable + + # Advertiser event name associated with the click tag. This field is used by + # DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when + # the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `eventName` + # @return [String] + attr_accessor :event_name + + # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative + # assets, this field must match the value of the creative asset's + # creativeAssetId.name field. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Parameter value for the specified click tag. This field contains a click- + # through url. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @event_name = args[:event_name] if args.key?(:event_name) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Click-through URL + class ClickThroughUrl + include Google::Apis::Core::Hashable + + # Read-only convenience field representing the actual URL that will be used for + # this click-through. The URL is computed as follows: + # - If defaultLandingPage is enabled then the campaign's default landing page + # URL is assigned to this field. + # - If defaultLandingPage is not enabled and a landingPageId is specified then + # that landing page's URL is assigned to this field. + # - If neither of the above cases apply, then the customClickThroughUrl is + # assigned to this field. + # Corresponds to the JSON property `computedClickThroughUrl` + # @return [String] + attr_accessor :computed_click_through_url + + # Custom click-through URL. Applicable if the defaultLandingPage field is set to + # false and the landingPageId field is left unset. + # Corresponds to the JSON property `customClickThroughUrl` + # @return [String] + attr_accessor :custom_click_through_url + + # Whether the campaign default landing page is used. + # Corresponds to the JSON property `defaultLandingPage` + # @return [Boolean] + attr_accessor :default_landing_page + alias_method :default_landing_page?, :default_landing_page + + # ID of the landing page for the click-through URL. Applicable if the + # defaultLandingPage field is set to false. + # Corresponds to the JSON property `landingPageId` + # @return [String] + attr_accessor :landing_page_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) + @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) + @default_landing_page = args[:default_landing_page] if args.key?(:default_landing_page) + @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) + end + end + + # Click Through URL Suffix settings. + class ClickThroughUrlSuffixProperties + include Google::Apis::Core::Hashable + + # Click-through URL suffix to apply to all ads in this entity's scope. Must be + # less than 128 characters long. + # Corresponds to the JSON property `clickThroughUrlSuffix` + # @return [String] + attr_accessor :click_through_url_suffix + + # Whether this entity should override the inherited click-through URL suffix + # with its own defined value. + # Corresponds to the JSON property `overrideInheritedSuffix` + # @return [Boolean] + attr_accessor :override_inherited_suffix + alias_method :override_inherited_suffix?, :override_inherited_suffix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) + @override_inherited_suffix = args[:override_inherited_suffix] if args.key?(:override_inherited_suffix) + end + end + + # Companion Click-through override. + class CompanionClickThroughOverride + include Google::Apis::Core::Hashable + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrl] + attr_accessor :click_through_url + + # ID of the creative for this companion click-through override. + # Corresponds to the JSON property `creativeId` + # @return [String] + attr_accessor :creative_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @creative_id = args[:creative_id] if args.key?(:creative_id) + end + end + + # Companion Settings + class CompanionSetting + include Google::Apis::Core::Hashable + + # Whether companions are disabled for this placement. + # Corresponds to the JSON property `companionsDisabled` + # @return [Boolean] + attr_accessor :companions_disabled + alias_method :companions_disabled?, :companions_disabled + + # Whitelist of companion sizes to be served to this placement. Set this list to + # null or empty to serve all companion sizes. + # Corresponds to the JSON property `enabledSizes` + # @return [Array] + attr_accessor :enabled_sizes + + # Whether to serve only static images as companions. + # Corresponds to the JSON property `imageOnly` + # @return [Boolean] + attr_accessor :image_only + alias_method :image_only?, :image_only + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#companionSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @companions_disabled = args[:companions_disabled] if args.key?(:companions_disabled) + @enabled_sizes = args[:enabled_sizes] if args.key?(:enabled_sizes) + @image_only = args[:image_only] if args.key?(:image_only) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a response to the queryCompatibleFields method. + class CompatibleFields + include Google::Apis::Core::Hashable + + # Represents fields that are compatible to be selected for a report of type " + # CROSS_DIMENSION_REACH". + # Corresponds to the JSON property `crossDimensionReachReportCompatibleFields` + # @return [Google::Apis::DfareportingV2_7::CrossDimensionReachReportCompatibleFields] + attr_accessor :cross_dimension_reach_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # FlOODLIGHT". + # Corresponds to the JSON property `floodlightReportCompatibleFields` + # @return [Google::Apis::DfareportingV2_7::FloodlightReportCompatibleFields] + attr_accessor :floodlight_report_compatible_fields + + # The kind of resource this is, in this case dfareporting#compatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Represents fields that are compatible to be selected for a report of type " + # PATH_TO_CONVERSION". + # Corresponds to the JSON property `pathToConversionReportCompatibleFields` + # @return [Google::Apis::DfareportingV2_7::PathToConversionReportCompatibleFields] + attr_accessor :path_to_conversion_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # REACH". + # Corresponds to the JSON property `reachReportCompatibleFields` + # @return [Google::Apis::DfareportingV2_7::ReachReportCompatibleFields] + attr_accessor :reach_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # STANDARD". + # Corresponds to the JSON property `reportCompatibleFields` + # @return [Google::Apis::DfareportingV2_7::ReportCompatibleFields] + attr_accessor :report_compatible_fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cross_dimension_reach_report_compatible_fields = args[:cross_dimension_reach_report_compatible_fields] if args.key?(:cross_dimension_reach_report_compatible_fields) + @floodlight_report_compatible_fields = args[:floodlight_report_compatible_fields] if args.key?(:floodlight_report_compatible_fields) + @kind = args[:kind] if args.key?(:kind) + @path_to_conversion_report_compatible_fields = args[:path_to_conversion_report_compatible_fields] if args.key?(:path_to_conversion_report_compatible_fields) + @reach_report_compatible_fields = args[:reach_report_compatible_fields] if args.key?(:reach_report_compatible_fields) + @report_compatible_fields = args[:report_compatible_fields] if args.key?(:report_compatible_fields) + end + end + + # Contains information about an internet connection type that can be targeted by + # ads. Clients can use the connection type to target mobile vs. broadband users. + class ConnectionType + include Google::Apis::Core::Hashable + + # ID of this connection type. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#connectionType". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this connection type. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Connection Type List Response + class ConnectionTypesListResponse + include Google::Apis::Core::Hashable + + # Collection of connection types such as broadband and mobile. + # Corresponds to the JSON property `connectionTypes` + # @return [Array] + attr_accessor :connection_types + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#connectionTypesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connection_types = args[:connection_types] if args.key?(:connection_types) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Content Category List Response + class ContentCategoriesListResponse + include Google::Apis::Core::Hashable + + # Content category collection. + # Corresponds to the JSON property `contentCategories` + # @return [Array] + attr_accessor :content_categories + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#contentCategoriesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_categories = args[:content_categories] if args.key?(:content_categories) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Organizes placements according to the contents of their associated webpages. + class ContentCategory + include Google::Apis::Core::Hashable + + # Account ID of this content category. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # ID of this content category. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#contentCategory". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this content category. This is a required field and must be less than + # 256 characters long and unique among content categories of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # A Conversion represents when a user successfully performs a desired action + # after seeing an ad. + class Conversion + include Google::Apis::Core::Hashable + + # Whether the conversion was directed toward children. + # Corresponds to the JSON property `childDirectedTreatment` + # @return [Boolean] + attr_accessor :child_directed_treatment + alias_method :child_directed_treatment?, :child_directed_treatment + + # Custom floodlight variables. + # Corresponds to the JSON property `customVariables` + # @return [Array] + attr_accessor :custom_variables + + # The alphanumeric encrypted user ID. When set, encryptionInfo should also be + # specified. This field is mutually exclusive with encryptedUserIdCandidates[] + # and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a + # required field. + # Corresponds to the JSON property `encryptedUserId` + # @return [String] + attr_accessor :encrypted_user_id + + # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior + # to the conversion timestamp will be used in the inserted conversion. If no + # such user ID is found then the conversion will be rejected with + # NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. + # This field should only be used when calling conversions.batchinsert. This + # field is mutually exclusive with encryptedUserId and mobileDeviceId. This or + # encryptedUserId or mobileDeviceId is a required field. + # Corresponds to the JSON property `encryptedUserIdCandidates` + # @return [Array] + attr_accessor :encrypted_user_id_candidates + + # Floodlight Activity ID of this conversion. This is a required field. + # Corresponds to the JSON property `floodlightActivityId` + # @return [String] + attr_accessor :floodlight_activity_id + + # Floodlight Configuration ID of this conversion. This is a required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [String] + attr_accessor :floodlight_configuration_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversion". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be + # used for reporting but not targeting. This will prevent remarketing. + # Corresponds to the JSON property `limitAdTracking` + # @return [Boolean] + attr_accessor :limit_ad_tracking + alias_method :limit_ad_tracking?, :limit_ad_tracking + + # The mobile device ID. This field is mutually exclusive with encryptedUserId + # and encryptedUserIdCandidates[]. This or encryptedUserId or + # encryptedUserIdCandidates[] is a required field. + # Corresponds to the JSON property `mobileDeviceId` + # @return [String] + attr_accessor :mobile_device_id + + # The ordinal of the conversion. Use this field to control how conversions of + # the same user and day are de-duplicated. This is a required field. + # Corresponds to the JSON property `ordinal` + # @return [String] + attr_accessor :ordinal + + # The quantity of the conversion. + # Corresponds to the JSON property `quantity` + # @return [String] + attr_accessor :quantity + + # The timestamp of conversion, in Unix epoch micros. This is a required field. + # Corresponds to the JSON property `timestampMicros` + # @return [String] + attr_accessor :timestamp_micros + + # The value of the conversion. + # Corresponds to the JSON property `value` + # @return [Float] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment) + @custom_variables = args[:custom_variables] if args.key?(:custom_variables) + @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id) + @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @kind = args[:kind] if args.key?(:kind) + @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking) + @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) + @ordinal = args[:ordinal] if args.key?(:ordinal) + @quantity = args[:quantity] if args.key?(:quantity) + @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) + @value = args[:value] if args.key?(:value) + end + end + + # The error code and description for a conversion that failed to insert or + # update. + class ConversionError + include Google::Apis::Core::Hashable + + # The error code. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionError". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A description of the error. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @kind = args[:kind] if args.key?(:kind) + @message = args[:message] if args.key?(:message) + end + end + + # The original conversion that was inserted or updated and whether there were + # any errors. + class ConversionStatus + include Google::Apis::Core::Hashable + + # A Conversion represents when a user successfully performs a desired action + # after seeing an ad. + # Corresponds to the JSON property `conversion` + # @return [Google::Apis::DfareportingV2_7::Conversion] + attr_accessor :conversion + + # A list of errors related to this conversion. + # Corresponds to the JSON property `errors` + # @return [Array] + attr_accessor :errors + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionStatus". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversion = args[:conversion] if args.key?(:conversion) + @errors = args[:errors] if args.key?(:errors) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Conversions Request. + class ConversionsBatchInsertRequest + include Google::Apis::Core::Hashable + + # The set of conversions to insert. + # Corresponds to the JSON property `conversions` + # @return [Array] + attr_accessor :conversions + + # A description of how user IDs are encrypted. + # Corresponds to the JSON property `encryptionInfo` + # @return [Google::Apis::DfareportingV2_7::EncryptionInfo] + attr_accessor :encryption_info + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchInsertRequest". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversions = args[:conversions] if args.key?(:conversions) + @encryption_info = args[:encryption_info] if args.key?(:encryption_info) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Conversions Response. + class ConversionsBatchInsertResponse + include Google::Apis::Core::Hashable + + # Indicates that some or all conversions failed to insert. + # Corresponds to the JSON property `hasFailures` + # @return [Boolean] + attr_accessor :has_failures + alias_method :has_failures?, :has_failures + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchInsertResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The status of each conversion's insertion status. The status is returned in + # the same order that conversions are inserted. + # Corresponds to the JSON property `status` + # @return [Array] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @has_failures = args[:has_failures] if args.key?(:has_failures) + @kind = args[:kind] if args.key?(:kind) + @status = args[:status] if args.key?(:status) + end + end + + # Country List Response + class CountriesListResponse + include Google::Apis::Core::Hashable + + # Country collection. + # Corresponds to the JSON property `countries` + # @return [Array] + attr_accessor :countries + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#countriesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @countries = args[:countries] if args.key?(:countries) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a country that can be targeted by ads. + class Country + include Google::Apis::Core::Hashable + + # Country code. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of this country. This is the ID used for targeting and generating + # reports. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#country". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this country. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether ad serving supports secure servers in this country. + # Corresponds to the JSON property `sslEnabled` + # @return [Boolean] + attr_accessor :ssl_enabled + alias_method :ssl_enabled?, :ssl_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @ssl_enabled = args[:ssl_enabled] if args.key?(:ssl_enabled) + end + end + + # Contains properties of a Creative. + class Creative + include Google::Apis::Core::Hashable + + # Account ID of this creative. This field, if left unset, will be auto-generated + # for both insert and update operations. Applicable to all creative types. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether the creative is active. Applicable to all creative types. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Ad parameters user for VPAID creative. This is a read-only field. Applicable + # to the following creative types: all VPAID. + # Corresponds to the JSON property `adParameters` + # @return [String] + attr_accessor :ad_parameters + + # Keywords for a Rich Media creative. Keywords let you customize the creative + # settings of a Rich Media ad running on your site without having to contact the + # advertiser. You can use keywords to dynamically change the look or + # functionality of a creative. Applicable to the following creative types: all + # RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `adTagKeys` + # @return [Array] + attr_accessor :ad_tag_keys + + # Advertiser ID of this creative. This is a required field. Applicable to all + # creative types. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Whether script access is allowed for this creative. This is a read-only and + # deprecated field which will automatically be set to true on update. Applicable + # to the following creative types: FLASH_INPAGE. + # Corresponds to the JSON property `allowScriptAccess` + # @return [Boolean] + attr_accessor :allow_script_access + alias_method :allow_script_access?, :allow_script_access + + # Whether the creative is archived. Applicable to all creative types. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Type of artwork used for the creative. This is a read-only field. Applicable + # to the following creative types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Source application where creative was authored. Presently, only DBM authored + # creatives will have this field set. Applicable to all creative types. + # Corresponds to the JSON property `authoringSource` + # @return [String] + attr_accessor :authoring_source + + # Authoring tool for HTML5 banner creatives. This is a read-only field. + # Applicable to the following creative types: HTML5_BANNER. + # Corresponds to the JSON property `authoringTool` + # @return [String] + attr_accessor :authoring_tool + + # Whether images are automatically advanced for image gallery creatives. + # Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + # Corresponds to the JSON property `auto_advance_images` + # @return [Boolean] + attr_accessor :auto_advance_images + alias_method :auto_advance_images?, :auto_advance_images + + # The 6-character HTML color code, beginning with #, for the background of the + # window area where the Flash file is displayed. Default is white. Applicable to + # the following creative types: FLASH_INPAGE. + # Corresponds to the JSON property `backgroundColor` + # @return [String] + attr_accessor :background_color + + # Click-through URL for backup image. Applicable to the following creative types: + # FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset + # type is not HTML_IMAGE. + # Corresponds to the JSON property `backupImageClickThroughUrl` + # @return [String] + attr_accessor :backup_image_click_through_url + + # List of feature dependencies that will cause a backup image to be served if + # the browser that serves the ad does not support them. Feature dependencies are + # features that a browser must be able to support in order to render your HTML5 + # creative asset correctly. This field is initially auto-generated to contain + # all features detected by DCM for all the assets of this creative and can then + # be modified by the client. To reset this field, copy over all the + # creativeAssets' detected features. Applicable to the following creative types: + # HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not + # HTML_IMAGE. + # Corresponds to the JSON property `backupImageFeatures` + # @return [Array] + attr_accessor :backup_image_features + + # Reporting label used for HTML5 banner backup image. Applicable to the + # following creative types: DISPLAY when the primary asset type is not + # HTML_IMAGE. + # Corresponds to the JSON property `backupImageReportingLabel` + # @return [String] + attr_accessor :backup_image_reporting_label + + # Target Window. + # Corresponds to the JSON property `backupImageTargetWindow` + # @return [Google::Apis::DfareportingV2_7::TargetWindow] + attr_accessor :backup_image_target_window + + # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER + # creatives, this is a subset of detected click tags for the assets associated + # with this creative. After creating a flash asset, detected click tags will be + # returned in the creativeAssetMetadata. When inserting the creative, populate + # the creative clickTags field using the creativeAssetMetadata.clickTags field. + # For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this + # list for each image creative asset. A click tag is matched with a + # corresponding creative asset by matching the clickTag.name field with the + # creativeAsset.assetIdentifier.name field. Applicable to the following creative + # types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to + # DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `clickTags` + # @return [Array] + attr_accessor :click_tags + + # Industry standard ID assigned to creative for reach and frequency. Applicable + # to the following creative types: all INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `commercialId` + # @return [String] + attr_accessor :commercial_id + + # List of companion creatives assigned to an in-Stream videocreative. Acceptable + # values include IDs of existing flash and image creatives. Applicable to the + # following creative types: all VPAID and all INSTREAM_VIDEO with + # dynamicAssetSelection set to false. + # Corresponds to the JSON property `companionCreatives` + # @return [Array] + attr_accessor :companion_creatives + + # Compatibilities associated with this creative. This is a read-only field. + # DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on + # mobile devices or in mobile apps for regular or interstitial ads, respectively. + # APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing + # creatives may have these compatibilities since new creatives will either be + # assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to + # rendering in in-stream video ads developed with the VAST standard. Applicable + # to all creative types. + # Acceptable values are: + # - "APP" + # - "APP_INTERSTITIAL" + # - "IN_STREAM_VIDEO" + # - "DISPLAY" + # - "DISPLAY_INTERSTITIAL" + # Corresponds to the JSON property `compatibility` + # @return [Array] + attr_accessor :compatibility + + # Whether Flash assets associated with the creative need to be automatically + # converted to HTML5. This flag is enabled by default and users can choose to + # disable it if they don't want the system to generate and use HTML5 asset for + # this creative. Applicable to the following creative type: FLASH_INPAGE. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `convertFlashToHtml5` + # @return [Boolean] + attr_accessor :convert_flash_to_html5 + alias_method :convert_flash_to_html5?, :convert_flash_to_html5 + + # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY + # creatives, these are read-only and auto-generated from clickTags. Applicable + # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and + # all VPAID. + # Corresponds to the JSON property `counterCustomEvents` + # @return [Array] + attr_accessor :counter_custom_events + + # Encapsulates the list of rules for asset selection and a default asset in case + # none of the rules match. Applicable to INSTREAM_VIDEO creatives. + # Corresponds to the JSON property `creativeAssetSelection` + # @return [Google::Apis::DfareportingV2_7::CreativeAssetSelection] + attr_accessor :creative_asset_selection + + # Assets associated with a creative. Applicable to all but the following + # creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and + # REDIRECT + # Corresponds to the JSON property `creativeAssets` + # @return [Array] + attr_accessor :creative_assets + + # Creative field assignments for this creative. Applicable to all creative types. + # Corresponds to the JSON property `creativeFieldAssignments` + # @return [Array] + attr_accessor :creative_field_assignments + + # Custom key-values for a Rich Media creative. Key-values let you customize the + # creative settings of a Rich Media ad running on your site without having to + # contact the advertiser. You can use key-values to dynamically change the look + # or functionality of a creative. Applicable to the following creative types: + # all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `customKeyValues` + # @return [Array] + attr_accessor :custom_key_values + + # Set this to true to enable the use of rules to target individual assets in + # this creative. When set to true creativeAssetSelection must be set. This also + # controls asset-level companions. When this is true, companion creatives should + # be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO + # creatives. + # Corresponds to the JSON property `dynamicAssetSelection` + # @return [Boolean] + attr_accessor :dynamic_asset_selection + alias_method :dynamic_asset_selection?, :dynamic_asset_selection + + # List of exit events configured for the creative. For DISPLAY and + # DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from + # clickTags, For DISPLAY, an event is also created from the + # backupImageReportingLabel. Applicable to the following creative types: + # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY + # when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `exitCustomEvents` + # @return [Array] + attr_accessor :exit_custom_events + + # FsCommand. + # Corresponds to the JSON property `fsCommand` + # @return [Google::Apis::DfareportingV2_7::FsCommand] + attr_accessor :fs_command + + # HTML code for the creative. This is a required field when applicable. This + # field is ignored if htmlCodeLocked is false. Applicable to the following + # creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. + # Corresponds to the JSON property `htmlCode` + # @return [String] + attr_accessor :html_code + + # Whether HTML code is DCM-generated or manually entered. Set to true to ignore + # changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE + # and HTML5_BANNER. + # Corresponds to the JSON property `htmlCodeLocked` + # @return [Boolean] + attr_accessor :html_code_locked + alias_method :html_code_locked?, :html_code_locked + + # ID of this creative. This is a read-only, auto-generated field. Applicable to + # all creative types. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creative". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Latest Studio trafficked creative ID associated with rich media and VPAID + # creatives. This is a read-only field. Applicable to the following creative + # types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `latestTraffickedCreativeId` + # @return [String] + attr_accessor :latest_trafficked_creative_id + + # Name of the creative. This is a required field and must be less than 256 + # characters long. Applicable to all creative types. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Override CSS value for rich media creatives. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `overrideCss` + # @return [String] + attr_accessor :override_css + + # Video Offset + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DfareportingV2_7::VideoOffset] + attr_accessor :progress_offset + + # URL of hosted image or hosted video or another ad tag. For + # INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. + # The standard for a VAST (Video Ad Serving Template) ad response allows for a + # redirect link to another VAST 2.0 or 3.0 call. This is a required field when + # applicable. Applicable to the following creative types: DISPLAY_REDIRECT, + # INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + # Corresponds to the JSON property `redirectUrl` + # @return [String] + attr_accessor :redirect_url + + # ID of current rendering version. This is a read-only field. Applicable to all + # creative types. + # Corresponds to the JSON property `renderingId` + # @return [String] + attr_accessor :rendering_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `renderingIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :rendering_id_dimension_value + + # The minimum required Flash plugin version for this creative. For example, 11.2. + # 202.235. This is a read-only field. Applicable to the following creative types: + # all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `requiredFlashPluginVersion` + # @return [String] + attr_accessor :required_flash_plugin_version + + # The internal Flash version for this creative as calculated by DoubleClick + # Studio. This is a read-only field. Applicable to the following creative types: + # FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the + # primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `requiredFlashVersion` + # @return [Fixnum] + attr_accessor :required_flash_version + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :size + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV2_7::VideoOffset] + attr_accessor :skip_offset + + # Whether the user can choose to skip the creative. Applicable to the following + # creative types: all INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `skippable` + # @return [Boolean] + attr_accessor :skippable + alias_method :skippable?, :skippable + + # Whether the creative is SSL-compliant. This is a read-only field. Applicable + # to all creative types. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether creative should be treated as SSL compliant even if the system scan + # shows it's not. Applicable to all creative types. + # Corresponds to the JSON property `sslOverride` + # @return [Boolean] + attr_accessor :ssl_override + alias_method :ssl_override?, :ssl_override + + # Studio advertiser ID associated with rich media and VPAID creatives. This is a + # read-only field. Applicable to the following creative types: all RICH_MEDIA, + # and all VPAID. + # Corresponds to the JSON property `studioAdvertiserId` + # @return [String] + attr_accessor :studio_advertiser_id + + # Studio creative ID associated with rich media and VPAID creatives. This is a + # read-only field. Applicable to the following creative types: all RICH_MEDIA, + # and all VPAID. + # Corresponds to the JSON property `studioCreativeId` + # @return [String] + attr_accessor :studio_creative_id + + # Studio trafficked creative ID associated with rich media and VPAID creatives. + # This is a read-only field. Applicable to the following creative types: all + # RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `studioTraffickedCreativeId` + # @return [String] + attr_accessor :studio_trafficked_creative_id + + # Subaccount ID of this creative. This field, if left unset, will be auto- + # generated for both insert and update operations. Applicable to all creative + # types. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Third-party URL used to record backup image impressions. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl` + # @return [String] + attr_accessor :third_party_backup_image_impressions_url + + # Third-party URL used to record rich media impressions. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `thirdPartyRichMediaImpressionsUrl` + # @return [String] + attr_accessor :third_party_rich_media_impressions_url + + # Third-party URLs for tracking in-stream video creative events. Applicable to + # the following creative types: all INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `thirdPartyUrls` + # @return [Array] + attr_accessor :third_party_urls + + # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY + # creatives, these are read-only and auto-generated from clickTags. Applicable + # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and + # all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. + # Corresponds to the JSON property `timerCustomEvents` + # @return [Array] + attr_accessor :timer_custom_events + + # Combined size of all creative assets. This is a read-only field. Applicable to + # the following creative types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `totalFileSize` + # @return [String] + attr_accessor :total_file_size + + # Type of this creative. This is a required field. Applicable to all creative + # types. + # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing + # creatives. New creatives should use DISPLAY as a replacement for these types. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The version number helps you keep track of multiple versions of your creative + # in your reports. The version number will always be auto-generated during + # insert operations to start at 1. For tracking creatives the version cannot be + # incremented and will always remain at 1. For all other creative types the + # version can be incremented only by 1 during update operations. In addition, + # the version will be automatically incremented by 1 when undergoing Rich Media + # creative merging. Applicable to all creative types. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + # Description of the video ad. Applicable to the following creative types: all + # INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `videoDescription` + # @return [String] + attr_accessor :video_description + + # Creative video duration in seconds. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `videoDuration` + # @return [Float] + attr_accessor :video_duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @ad_parameters = args[:ad_parameters] if args.key?(:ad_parameters) + @ad_tag_keys = args[:ad_tag_keys] if args.key?(:ad_tag_keys) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @allow_script_access = args[:allow_script_access] if args.key?(:allow_script_access) + @archived = args[:archived] if args.key?(:archived) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @authoring_source = args[:authoring_source] if args.key?(:authoring_source) + @authoring_tool = args[:authoring_tool] if args.key?(:authoring_tool) + @auto_advance_images = args[:auto_advance_images] if args.key?(:auto_advance_images) + @background_color = args[:background_color] if args.key?(:background_color) + @backup_image_click_through_url = args[:backup_image_click_through_url] if args.key?(:backup_image_click_through_url) + @backup_image_features = args[:backup_image_features] if args.key?(:backup_image_features) + @backup_image_reporting_label = args[:backup_image_reporting_label] if args.key?(:backup_image_reporting_label) + @backup_image_target_window = args[:backup_image_target_window] if args.key?(:backup_image_target_window) + @click_tags = args[:click_tags] if args.key?(:click_tags) + @commercial_id = args[:commercial_id] if args.key?(:commercial_id) + @companion_creatives = args[:companion_creatives] if args.key?(:companion_creatives) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @convert_flash_to_html5 = args[:convert_flash_to_html5] if args.key?(:convert_flash_to_html5) + @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events) + @creative_asset_selection = args[:creative_asset_selection] if args.key?(:creative_asset_selection) + @creative_assets = args[:creative_assets] if args.key?(:creative_assets) + @creative_field_assignments = args[:creative_field_assignments] if args.key?(:creative_field_assignments) + @custom_key_values = args[:custom_key_values] if args.key?(:custom_key_values) + @dynamic_asset_selection = args[:dynamic_asset_selection] if args.key?(:dynamic_asset_selection) + @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events) + @fs_command = args[:fs_command] if args.key?(:fs_command) + @html_code = args[:html_code] if args.key?(:html_code) + @html_code_locked = args[:html_code_locked] if args.key?(:html_code_locked) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] if args.key?(:latest_trafficked_creative_id) + @name = args[:name] if args.key?(:name) + @override_css = args[:override_css] if args.key?(:override_css) + @progress_offset = args[:progress_offset] if args.key?(:progress_offset) + @redirect_url = args[:redirect_url] if args.key?(:redirect_url) + @rendering_id = args[:rendering_id] if args.key?(:rendering_id) + @rendering_id_dimension_value = args[:rendering_id_dimension_value] if args.key?(:rendering_id_dimension_value) + @required_flash_plugin_version = args[:required_flash_plugin_version] if args.key?(:required_flash_plugin_version) + @required_flash_version = args[:required_flash_version] if args.key?(:required_flash_version) + @size = args[:size] if args.key?(:size) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @skippable = args[:skippable] if args.key?(:skippable) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_override = args[:ssl_override] if args.key?(:ssl_override) + @studio_advertiser_id = args[:studio_advertiser_id] if args.key?(:studio_advertiser_id) + @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id) + @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url) + @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url) + @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls) + @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events) + @total_file_size = args[:total_file_size] if args.key?(:total_file_size) + @type = args[:type] if args.key?(:type) + @version = args[:version] if args.key?(:version) + @video_description = args[:video_description] if args.key?(:video_description) + @video_duration = args[:video_duration] if args.key?(:video_duration) + end + end + + # Creative Asset. + class CreativeAsset + include Google::Apis::Core::Hashable + + # Whether ActionScript3 is enabled for the flash asset. This is a read-only + # field. Applicable to the following creative type: FLASH_INPAGE. Applicable to + # DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `actionScript3` + # @return [Boolean] + attr_accessor :action_script3 + alias_method :action_script3?, :action_script3 + + # Whether the video asset is active. This is a read-only field for + # VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: + # INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Possible alignments for an asset. This is a read-only field. Applicable to the + # following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + # Corresponds to the JSON property `alignment` + # @return [String] + attr_accessor :alignment + + # Artwork type of rich media creative. This is a read-only field. Applicable to + # the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Creative Asset ID. + # Corresponds to the JSON property `assetIdentifier` + # @return [Google::Apis::DfareportingV2_7::CreativeAssetId] + attr_accessor :asset_identifier + + # Creative Custom Event. + # Corresponds to the JSON property `backupImageExit` + # @return [Google::Apis::DfareportingV2_7::CreativeCustomEvent] + attr_accessor :backup_image_exit + + # Detected bit-rate for video asset. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `bitRate` + # @return [Fixnum] + attr_accessor :bit_rate + + # Rich media child asset type. This is a read-only field. Applicable to the + # following creative types: all VPAID. + # Corresponds to the JSON property `childAssetType` + # @return [String] + attr_accessor :child_asset_type + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `collapsedSize` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :collapsed_size + + # List of companion creatives assigned to an in-stream video creative asset. + # Acceptable values include IDs of existing flash and image creatives. + # Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to + # true. + # Corresponds to the JSON property `companionCreativeIds` + # @return [Array] + attr_accessor :companion_creative_ids + + # Custom start time in seconds for making the asset visible. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `customStartTimeValue` + # @return [Fixnum] + attr_accessor :custom_start_time_value + + # List of feature dependencies for the creative asset that are detected by DCM. + # Feature dependencies are features that a browser must be able to support in + # order to render your HTML5 creative correctly. This is a read-only, auto- + # generated field. Applicable to the following creative types: HTML5_BANNER. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `detectedFeatures` + # @return [Array] + attr_accessor :detected_features + + # Type of rich media asset. This is a read-only field. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `displayType` + # @return [String] + attr_accessor :display_type + + # Duration in seconds for which an asset will be displayed. Applicable to the + # following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. + # Corresponds to the JSON property `duration` + # @return [Fixnum] + attr_accessor :duration + + # Duration type for which an asset will be displayed. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `durationType` + # @return [String] + attr_accessor :duration_type + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `expandedDimension` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :expanded_dimension + + # File size associated with this creative asset. This is a read-only field. + # Applicable to all but the following creative types: all REDIRECT and + # TRACKING_TEXT. + # Corresponds to the JSON property `fileSize` + # @return [String] + attr_accessor :file_size + + # Flash version of the asset. This is a read-only field. Applicable to the + # following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `flashVersion` + # @return [Fixnum] + attr_accessor :flash_version + + # Whether to hide Flash objects flag for an asset. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `hideFlashObjects` + # @return [Boolean] + attr_accessor :hide_flash_objects + alias_method :hide_flash_objects?, :hide_flash_objects + + # Whether to hide selection boxes flag for an asset. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `hideSelectionBoxes` + # @return [Boolean] + attr_accessor :hide_selection_boxes + alias_method :hide_selection_boxes?, :hide_selection_boxes + + # Whether the asset is horizontally locked. This is a read-only field. + # Applicable to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `horizontallyLocked` + # @return [Boolean] + attr_accessor :horizontally_locked + alias_method :horizontally_locked?, :horizontally_locked + + # Numeric ID of this creative asset. This is a required field and should not be + # modified. Applicable to all but the following creative types: all REDIRECT and + # TRACKING_TEXT. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Detected MIME type for video asset. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # Offset Position. + # Corresponds to the JSON property `offset` + # @return [Google::Apis::DfareportingV2_7::OffsetPosition] + attr_accessor :offset + + # Whether the backup asset is original or changed by the user in DCM. Applicable + # to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `originalBackup` + # @return [Boolean] + attr_accessor :original_backup + alias_method :original_backup?, :original_backup + + # Offset Position. + # Corresponds to the JSON property `position` + # @return [Google::Apis::DfareportingV2_7::OffsetPosition] + attr_accessor :position + + # Offset left unit for an asset. This is a read-only field. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `positionLeftUnit` + # @return [String] + attr_accessor :position_left_unit + + # Offset top unit for an asset. This is a read-only field if the asset + # displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `positionTopUnit` + # @return [String] + attr_accessor :position_top_unit + + # Progressive URL for video asset. This is a read-only field. Applicable to the + # following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `progressiveServingUrl` + # @return [String] + attr_accessor :progressive_serving_url + + # Whether the asset pushes down other content. Applicable to the following + # creative types: all RICH_MEDIA. Additionally, only applicable when the asset + # offsets are 0, the collapsedSize.width matches size.width, and the + # collapsedSize.height is less than size.height. + # Corresponds to the JSON property `pushdown` + # @return [Boolean] + attr_accessor :pushdown + alias_method :pushdown?, :pushdown + + # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. + # Applicable to the following creative types: all RICH_MEDIA.Additionally, only + # applicable when the asset pushdown field is true, the offsets are 0, the + # collapsedSize.width matches size.width, and the collapsedSize.height is less + # than size.height. + # Corresponds to the JSON property `pushdownDuration` + # @return [Float] + attr_accessor :pushdown_duration + + # Role of the asset in relation to creative. Applicable to all but the following + # creative types: all REDIRECT and TRACKING_TEXT. This is a required field. + # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, + # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary + # assets), and all VPAID creatives. + # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all + # VPAID creatives. Applicable to DISPLAY when the primary asset type is not + # HTML_IMAGE. + # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. + # OTHER refers to assets from sources other than DCM, such as Studio uploaded + # assets, applicable to all RICH_MEDIA and all VPAID creatives. + # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to + # INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. + # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets + # and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. + # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from + # Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be + # added or removed within DCM. + # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and + # ALTERNATE_VIDEO assets that are marked active serve as backup in case the + # VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or + # removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :size + + # Whether the asset is SSL-compliant. This is a read-only field. Applicable to + # all but the following creative types: all REDIRECT and TRACKING_TEXT. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Initial wait time type before making the asset visible. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `startTimeType` + # @return [String] + attr_accessor :start_time_type + + # Streaming URL for video asset. This is a read-only field. Applicable to the + # following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `streamingServingUrl` + # @return [String] + attr_accessor :streaming_serving_url + + # Whether the asset is transparent. Applicable to the following creative types: + # all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + # Corresponds to the JSON property `transparency` + # @return [Boolean] + attr_accessor :transparency + alias_method :transparency?, :transparency + + # Whether the asset is vertically locked. This is a read-only field. Applicable + # to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `verticallyLocked` + # @return [Boolean] + attr_accessor :vertically_locked + alias_method :vertically_locked?, :vertically_locked + + # Detected video duration for video asset. This is a read-only field. Applicable + # to the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `videoDuration` + # @return [Float] + attr_accessor :video_duration + + # Window mode options for flash assets. Applicable to the following creative + # types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, + # RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. + # Corresponds to the JSON property `windowMode` + # @return [String] + attr_accessor :window_mode + + # zIndex value of an asset. This is a read-only field. Applicable to the + # following creative types: all RICH_MEDIA.Additionally, only applicable to + # assets whose displayType is NOT one of the following types: + # ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. + # Corresponds to the JSON property `zIndex` + # @return [Fixnum] + attr_accessor :z_index + + # File name of zip file. This is a read-only field. Applicable to the following + # creative types: HTML5_BANNER. + # Corresponds to the JSON property `zipFilename` + # @return [String] + attr_accessor :zip_filename + + # Size of zip file. This is a read-only field. Applicable to the following + # creative types: HTML5_BANNER. + # Corresponds to the JSON property `zipFilesize` + # @return [String] + attr_accessor :zip_filesize + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action_script3 = args[:action_script3] if args.key?(:action_script3) + @active = args[:active] if args.key?(:active) + @alignment = args[:alignment] if args.key?(:alignment) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) + @backup_image_exit = args[:backup_image_exit] if args.key?(:backup_image_exit) + @bit_rate = args[:bit_rate] if args.key?(:bit_rate) + @child_asset_type = args[:child_asset_type] if args.key?(:child_asset_type) + @collapsed_size = args[:collapsed_size] if args.key?(:collapsed_size) + @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids) + @custom_start_time_value = args[:custom_start_time_value] if args.key?(:custom_start_time_value) + @detected_features = args[:detected_features] if args.key?(:detected_features) + @display_type = args[:display_type] if args.key?(:display_type) + @duration = args[:duration] if args.key?(:duration) + @duration_type = args[:duration_type] if args.key?(:duration_type) + @expanded_dimension = args[:expanded_dimension] if args.key?(:expanded_dimension) + @file_size = args[:file_size] if args.key?(:file_size) + @flash_version = args[:flash_version] if args.key?(:flash_version) + @hide_flash_objects = args[:hide_flash_objects] if args.key?(:hide_flash_objects) + @hide_selection_boxes = args[:hide_selection_boxes] if args.key?(:hide_selection_boxes) + @horizontally_locked = args[:horizontally_locked] if args.key?(:horizontally_locked) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @offset = args[:offset] if args.key?(:offset) + @original_backup = args[:original_backup] if args.key?(:original_backup) + @position = args[:position] if args.key?(:position) + @position_left_unit = args[:position_left_unit] if args.key?(:position_left_unit) + @position_top_unit = args[:position_top_unit] if args.key?(:position_top_unit) + @progressive_serving_url = args[:progressive_serving_url] if args.key?(:progressive_serving_url) + @pushdown = args[:pushdown] if args.key?(:pushdown) + @pushdown_duration = args[:pushdown_duration] if args.key?(:pushdown_duration) + @role = args[:role] if args.key?(:role) + @size = args[:size] if args.key?(:size) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @start_time_type = args[:start_time_type] if args.key?(:start_time_type) + @streaming_serving_url = args[:streaming_serving_url] if args.key?(:streaming_serving_url) + @transparency = args[:transparency] if args.key?(:transparency) + @vertically_locked = args[:vertically_locked] if args.key?(:vertically_locked) + @video_duration = args[:video_duration] if args.key?(:video_duration) + @window_mode = args[:window_mode] if args.key?(:window_mode) + @z_index = args[:z_index] if args.key?(:z_index) + @zip_filename = args[:zip_filename] if args.key?(:zip_filename) + @zip_filesize = args[:zip_filesize] if args.key?(:zip_filesize) + end + end + + # Creative Asset ID. + class CreativeAssetId + include Google::Apis::Core::Hashable + + # Name of the creative asset. This is a required field while inserting an asset. + # After insertion, this assetIdentifier is used to identify the uploaded asset. + # Characters in the name must be alphanumeric or one of the following: ".-_ ". + # Spaces are allowed. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Type of asset to upload. This is a required field. FLASH and IMAGE are no + # longer supported for new uploads. All image assets should use HTML_IMAGE. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # CreativeAssets contains properties of a creative asset file which will be + # uploaded or has already been uploaded. Refer to the creative sample code for + # how to upload assets and insert a creative. + class CreativeAssetMetadata + include Google::Apis::Core::Hashable + + # Creative Asset ID. + # Corresponds to the JSON property `assetIdentifier` + # @return [Google::Apis::DfareportingV2_7::CreativeAssetId] + attr_accessor :asset_identifier + + # List of detected click tags for assets. This is a read-only auto-generated + # field. + # Corresponds to the JSON property `clickTags` + # @return [Array] + attr_accessor :click_tags + + # List of feature dependencies for the creative asset that are detected by DCM. + # Feature dependencies are features that a browser must be able to support in + # order to render your HTML5 creative correctly. This is a read-only, auto- + # generated field. + # Corresponds to the JSON property `detectedFeatures` + # @return [Array] + attr_accessor :detected_features + + # Numeric ID of the asset. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeAssetMetadata". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Rules validated during code generation that generated a warning. This is a + # read-only, auto-generated field. + # Possible values are: + # - "ADMOB_REFERENCED" + # - "ASSET_FORMAT_UNSUPPORTED_DCM" + # - "ASSET_INVALID" + # - "CLICK_TAG_HARD_CODED" + # - "CLICK_TAG_INVALID" + # - "CLICK_TAG_IN_GWD" + # - "CLICK_TAG_MISSING" + # - "CLICK_TAG_MORE_THAN_ONE" + # - "CLICK_TAG_NON_TOP_LEVEL" + # - "COMPONENT_UNSUPPORTED_DCM" + # - "ENABLER_UNSUPPORTED_METHOD_DCM" + # - "EXTERNAL_FILE_REFERENCED" + # - "FILE_DETAIL_EMPTY" + # - "FILE_TYPE_INVALID" + # - "GWD_PROPERTIES_INVALID" + # - "HTML5_FEATURE_UNSUPPORTED" + # - "LINKED_FILE_NOT_FOUND" + # - "MAX_FLASH_VERSION_11" + # - "MRAID_REFERENCED" + # - "NOT_SSL_COMPLIANT" + # - "ORPHANED_ASSET" + # - "PRIMARY_HTML_MISSING" + # - "SVG_INVALID" + # - "ZIP_INVALID" + # Corresponds to the JSON property `warnedValidationRules` + # @return [Array] + attr_accessor :warned_validation_rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) + @click_tags = args[:click_tags] if args.key?(:click_tags) + @detected_features = args[:detected_features] if args.key?(:detected_features) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @warned_validation_rules = args[:warned_validation_rules] if args.key?(:warned_validation_rules) + end + end + + # Encapsulates the list of rules for asset selection and a default asset in case + # none of the rules match. Applicable to INSTREAM_VIDEO creatives. + class CreativeAssetSelection + include Google::Apis::Core::Hashable + + # A creativeAssets[].id. This should refer to one of the parent assets in this + # creative, and will be served if none of the rules match. This is a required + # field. + # Corresponds to the JSON property `defaultAssetId` + # @return [String] + attr_accessor :default_asset_id + + # Rules determine which asset will be served to a viewer. Rules will be + # evaluated in the order in which they are stored in this list. This list must + # contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_asset_id = args[:default_asset_id] if args.key?(:default_asset_id) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Creative Assignment. + class CreativeAssignment + include Google::Apis::Core::Hashable + + # Whether this creative assignment is active. When true, the creative will be + # included in the ad's rotation. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Whether applicable event tags should fire when this creative assignment is + # rendered. If this value is unset when the ad is inserted or updated, it will + # default to true for all creative types EXCEPT for INTERNAL_REDIRECT, + # INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + # Corresponds to the JSON property `applyEventTags` + # @return [Boolean] + attr_accessor :apply_event_tags + alias_method :apply_event_tags?, :apply_event_tags + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrl] + attr_accessor :click_through_url + + # Companion creative overrides for this creative assignment. Applicable to video + # ads. + # Corresponds to the JSON property `companionCreativeOverrides` + # @return [Array] + attr_accessor :companion_creative_overrides + + # Creative group assignments for this creative assignment. Only one assignment + # per creative group number is allowed for a maximum of two assignments. + # Corresponds to the JSON property `creativeGroupAssignments` + # @return [Array] + attr_accessor :creative_group_assignments + + # ID of the creative to be assigned. This is a required field. + # Corresponds to the JSON property `creativeId` + # @return [String] + attr_accessor :creative_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `creativeIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :creative_id_dimension_value + + # Date and time that the assigned creative should stop serving. Must be later + # than the start time. + # Corresponds to the JSON property `endTime` + # @return [DateTime] + attr_accessor :end_time + + # Rich media exit overrides for this creative assignment. + # Applicable when the creative type is any of the following: + # - RICH_MEDIA_INPAGE + # - RICH_MEDIA_INPAGE_FLOATING + # - RICH_MEDIA_IM_EXPAND + # - RICH_MEDIA_EXPANDING + # - RICH_MEDIA_INTERSTITIAL_FLOAT + # - RICH_MEDIA_MOBILE_IN_APP + # - RICH_MEDIA_MULTI_FLOATING + # - RICH_MEDIA_PEEL_DOWN + # - ADVANCED_BANNER + # - VPAID_LINEAR + # - VPAID_NON_LINEAR + # Corresponds to the JSON property `richMediaExitOverrides` + # @return [Array] + attr_accessor :rich_media_exit_overrides + + # Sequence number of the creative assignment, applicable when the rotation type + # is CREATIVE_ROTATION_TYPE_SEQUENTIAL. + # Corresponds to the JSON property `sequence` + # @return [Fixnum] + attr_accessor :sequence + + # Whether the creative to be assigned is SSL-compliant. This is a read-only + # field that is auto-generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Date and time that the assigned creative should start serving. + # Corresponds to the JSON property `startTime` + # @return [DateTime] + attr_accessor :start_time + + # Weight of the creative assignment, applicable when the rotation type is + # CREATIVE_ROTATION_TYPE_RANDOM. + # Corresponds to the JSON property `weight` + # @return [Fixnum] + attr_accessor :weight + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides) + @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value) + @end_time = args[:end_time] if args.key?(:end_time) + @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides) + @sequence = args[:sequence] if args.key?(:sequence) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @start_time = args[:start_time] if args.key?(:start_time) + @weight = args[:weight] if args.key?(:weight) + end + end + + # Creative Custom Event. + class CreativeCustomEvent + include Google::Apis::Core::Hashable + + # Unique ID of this event used by DDM Reporting and Data Transfer. This is a + # read-only field. + # Corresponds to the JSON property `advertiserCustomEventId` + # @return [String] + attr_accessor :advertiser_custom_event_id + + # User-entered name for the event. + # Corresponds to the JSON property `advertiserCustomEventName` + # @return [String] + attr_accessor :advertiser_custom_event_name + + # Type of the event. This is a read-only field. + # Corresponds to the JSON property `advertiserCustomEventType` + # @return [String] + attr_accessor :advertiser_custom_event_type + + # Artwork label column, used to link events in DCM back to events in Studio. + # This is a required field and should not be modified after insertion. + # Corresponds to the JSON property `artworkLabel` + # @return [String] + attr_accessor :artwork_label + + # Artwork type used by the creative.This is a read-only field. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Exit URL of the event. This field is used only for exit events. + # Corresponds to the JSON property `exitUrl` + # @return [String] + attr_accessor :exit_url + + # ID of this event. This is a required field and should not be modified after + # insertion. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Popup Window Properties. + # Corresponds to the JSON property `popupWindowProperties` + # @return [Google::Apis::DfareportingV2_7::PopupWindowProperties] + attr_accessor :popup_window_properties + + # Target type used by the event. + # Corresponds to the JSON property `targetType` + # @return [String] + attr_accessor :target_type + + # Video reporting ID, used to differentiate multiple videos in a single creative. + # This is a read-only field. + # Corresponds to the JSON property `videoReportingId` + # @return [String] + attr_accessor :video_reporting_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_custom_event_id = args[:advertiser_custom_event_id] if args.key?(:advertiser_custom_event_id) + @advertiser_custom_event_name = args[:advertiser_custom_event_name] if args.key?(:advertiser_custom_event_name) + @advertiser_custom_event_type = args[:advertiser_custom_event_type] if args.key?(:advertiser_custom_event_type) + @artwork_label = args[:artwork_label] if args.key?(:artwork_label) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @exit_url = args[:exit_url] if args.key?(:exit_url) + @id = args[:id] if args.key?(:id) + @popup_window_properties = args[:popup_window_properties] if args.key?(:popup_window_properties) + @target_type = args[:target_type] if args.key?(:target_type) + @video_reporting_id = args[:video_reporting_id] if args.key?(:video_reporting_id) + end + end + + # Contains properties of a creative field. + class CreativeField + include Google::Apis::Core::Hashable + + # Account ID of this creative field. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this creative field. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # ID of this creative field. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeField". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this creative field. This is a required field and must be less than + # 256 characters long and unique among creative fields of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this creative field. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Creative Field Assignment. + class CreativeFieldAssignment + include Google::Apis::Core::Hashable + + # ID of the creative field. + # Corresponds to the JSON property `creativeFieldId` + # @return [String] + attr_accessor :creative_field_id + + # ID of the creative field value. + # Corresponds to the JSON property `creativeFieldValueId` + # @return [String] + attr_accessor :creative_field_value_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_field_id = args[:creative_field_id] if args.key?(:creative_field_id) + @creative_field_value_id = args[:creative_field_value_id] if args.key?(:creative_field_value_id) + end + end + + # Contains properties of a creative field value. + class CreativeFieldValue + include Google::Apis::Core::Hashable + + # ID of this creative field value. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldValue". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Value of this creative field value. It needs to be less than 256 characters in + # length and unique per creative field. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @value = args[:value] if args.key?(:value) + end + end + + # Creative Field Value List Response + class CreativeFieldValuesListResponse + include Google::Apis::Core::Hashable + + # Creative field value collection. + # Corresponds to the JSON property `creativeFieldValues` + # @return [Array] + attr_accessor :creative_field_values + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldValuesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_field_values = args[:creative_field_values] if args.key?(:creative_field_values) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Creative Field List Response + class CreativeFieldsListResponse + include Google::Apis::Core::Hashable + + # Creative field collection. + # Corresponds to the JSON property `creativeFields` + # @return [Array] + attr_accessor :creative_fields + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_fields = args[:creative_fields] if args.key?(:creative_fields) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a creative group. + class CreativeGroup + include Google::Apis::Core::Hashable + + # Account ID of this creative group. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this creative group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Subgroup of the creative group. Assign your creative groups to one of the + # following subgroups in order to filter or manage them more easily. This field + # is required on insertion and is read-only after insertion. + # Acceptable values are: + # - 1 + # - 2 + # Corresponds to the JSON property `groupNumber` + # @return [Fixnum] + attr_accessor :group_number + + # ID of this creative group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this creative group. This is a required field and must be less than + # 256 characters long and unique among creative groups of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this creative group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @group_number = args[:group_number] if args.key?(:group_number) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Creative Group Assignment. + class CreativeGroupAssignment + include Google::Apis::Core::Hashable + + # ID of the creative group to be assigned. + # Corresponds to the JSON property `creativeGroupId` + # @return [String] + attr_accessor :creative_group_id + + # Creative group number of the creative group assignment. + # Corresponds to the JSON property `creativeGroupNumber` + # @return [String] + attr_accessor :creative_group_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_group_id = args[:creative_group_id] if args.key?(:creative_group_id) + @creative_group_number = args[:creative_group_number] if args.key?(:creative_group_number) + end + end + + # Creative Group List Response + class CreativeGroupsListResponse + include Google::Apis::Core::Hashable + + # Creative group collection. + # Corresponds to the JSON property `creativeGroups` + # @return [Array] + attr_accessor :creative_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_groups = args[:creative_groups] if args.key?(:creative_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Creative optimization settings. + class CreativeOptimizationConfiguration + include Google::Apis::Core::Hashable + + # ID of this creative optimization config. This field is auto-generated when the + # campaign is inserted or updated. It can be null for existing campaigns. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Name of this creative optimization config. This is a required field and must + # be less than 129 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of optimization activities associated with this configuration. + # Corresponds to the JSON property `optimizationActivitys` + # @return [Array] + attr_accessor :optimization_activitys + + # Optimization model for this configuration. + # Corresponds to the JSON property `optimizationModel` + # @return [String] + attr_accessor :optimization_model + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @optimization_activitys = args[:optimization_activitys] if args.key?(:optimization_activitys) + @optimization_model = args[:optimization_model] if args.key?(:optimization_model) + end + end + + # Creative Rotation. + class CreativeRotation + include Google::Apis::Core::Hashable + + # Creative assignments in this creative rotation. + # Corresponds to the JSON property `creativeAssignments` + # @return [Array] + attr_accessor :creative_assignments + + # Creative optimization configuration that is used by this ad. It should refer + # to one of the existing optimization configurations in the ad's campaign. If it + # is unset or set to 0, then the campaign's default optimization configuration + # will be used for this ad. + # Corresponds to the JSON property `creativeOptimizationConfigurationId` + # @return [String] + attr_accessor :creative_optimization_configuration_id + + # Type of creative rotation. Can be used to specify whether to use sequential or + # random rotation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. + # Corresponds to the JSON property `weightCalculationStrategy` + # @return [String] + attr_accessor :weight_calculation_strategy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_assignments = args[:creative_assignments] if args.key?(:creative_assignments) + @creative_optimization_configuration_id = args[:creative_optimization_configuration_id] if args.key?(:creative_optimization_configuration_id) + @type = args[:type] if args.key?(:type) + @weight_calculation_strategy = args[:weight_calculation_strategy] if args.key?(:weight_calculation_strategy) + end + end + + # Creative Settings + class CreativeSettings + include Google::Apis::Core::Hashable + + # Header text for iFrames for this site. Must be less than or equal to 2000 + # characters long. + # Corresponds to the JSON property `iFrameFooter` + # @return [String] + attr_accessor :i_frame_footer + + # Header text for iFrames for this site. Must be less than or equal to 2000 + # characters long. + # Corresponds to the JSON property `iFrameHeader` + # @return [String] + attr_accessor :i_frame_header + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @i_frame_footer = args[:i_frame_footer] if args.key?(:i_frame_footer) + @i_frame_header = args[:i_frame_header] if args.key?(:i_frame_header) + end + end + + # Creative List Response + class CreativesListResponse + include Google::Apis::Core::Hashable + + # Creative collection. + # Corresponds to the JSON property `creatives` + # @return [Array] + attr_accessor :creatives + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creatives = args[:creatives] if args.key?(:creatives) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # CROSS_DIMENSION_REACH". + class CrossDimensionReachReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "breakdown" section of + # the report. + # Corresponds to the JSON property `breakdown` + # @return [Array] + attr_accessor :breakdown + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The kind of resource this is, in this case dfareporting# + # crossDimensionReachReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected in the "overlapMetricNames" + # section of the report. + # Corresponds to the JSON property `overlapMetrics` + # @return [Array] + attr_accessor :overlap_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @breakdown = args[:breakdown] if args.key?(:breakdown) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @overlap_metrics = args[:overlap_metrics] if args.key?(:overlap_metrics) + end + end + + # A custom floodlight variable. + class CustomFloodlightVariable + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customFloodlightVariable". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The type of custom floodlight variable to supply a value for. These map to the + # "u[1-20]=" in the tags. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The value of the custom floodlight variable. The length of string must not + # exceed 50 characters. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a Custom Rich Media Events group. + class CustomRichMediaEvents + include Google::Apis::Core::Hashable + + # List of custom rich media event IDs. Dimension values must be all of type dfa: + # richMediaEventTypeIdAndName. + # Corresponds to the JSON property `filteredEventIds` + # @return [Array] + attr_accessor :filtered_event_ids + + # The kind of resource this is, in this case dfareporting#customRichMediaEvents. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filtered_event_ids = args[:filtered_event_ids] if args.key?(:filtered_event_ids) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a date range. + class DateRange + include Google::Apis::Core::Hashable + + # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" + # . + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # The kind of resource this is, in this case dfareporting#dateRange. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The date range relative to the date of when the report is run. + # Corresponds to the JSON property `relativeDateRange` + # @return [String] + attr_accessor :relative_date_range + + # The start date of the date range, inclusive. A string of the format: "yyyy-MM- + # dd". + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @kind = args[:kind] if args.key?(:kind) + @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Day Part Targeting. + class DayPartTargeting + include Google::Apis::Core::Hashable + + # Days of the week when the ad will serve. + # Acceptable values are: + # - "SUNDAY" + # - "MONDAY" + # - "TUESDAY" + # - "WEDNESDAY" + # - "THURSDAY" + # - "FRIDAY" + # - "SATURDAY" + # Corresponds to the JSON property `daysOfWeek` + # @return [Array] + attr_accessor :days_of_week + + # Hours of the day when the ad will serve. Must be an integer between 0 and 23 ( + # inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be + # specified with days of week, in which case the ad would serve during these + # hours on the specified days. For example, if Monday, Wednesday, Friday are the + # days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, + # the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. + # Corresponds to the JSON property `hoursOfDay` + # @return [Array] + attr_accessor :hours_of_day + + # Whether or not to use the user's local time. If false, the America/New York + # time zone applies. + # Corresponds to the JSON property `userLocalTime` + # @return [Boolean] + attr_accessor :user_local_time + alias_method :user_local_time?, :user_local_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @days_of_week = args[:days_of_week] if args.key?(:days_of_week) + @hours_of_day = args[:hours_of_day] if args.key?(:hours_of_day) + @user_local_time = args[:user_local_time] if args.key?(:user_local_time) + end + end + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + class DefaultClickThroughEventTagProperties + include Google::Apis::Core::Hashable + + # ID of the click-through event tag to apply to all ads in this entity's scope. + # Corresponds to the JSON property `defaultClickThroughEventTagId` + # @return [String] + attr_accessor :default_click_through_event_tag_id + + # Whether this entity should override the inherited default click-through event + # tag with its own defined value. + # Corresponds to the JSON property `overrideInheritedEventTag` + # @return [Boolean] + attr_accessor :override_inherited_event_tag + alias_method :override_inherited_event_tag?, :override_inherited_event_tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) + @override_inherited_event_tag = args[:override_inherited_event_tag] if args.key?(:override_inherited_event_tag) + end + end + + # Delivery Schedule. + class DeliverySchedule + include Google::Apis::Core::Hashable + + # Frequency Cap. + # Corresponds to the JSON property `frequencyCap` + # @return [Google::Apis::DfareportingV2_7::FrequencyCap] + attr_accessor :frequency_cap + + # Whether or not hard cutoff is enabled. If true, the ad will not serve after + # the end date and time. Otherwise the ad will continue to be served until it + # has reached its delivery goals. + # Corresponds to the JSON property `hardCutoff` + # @return [Boolean] + attr_accessor :hard_cutoff + alias_method :hard_cutoff?, :hard_cutoff + + # Impression ratio for this ad. This ratio determines how often each ad is + # served relative to the others. For example, if ad A has an impression ratio of + # 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times + # as often as ad A. Must be between 1 and 10. + # Corresponds to the JSON property `impressionRatio` + # @return [String] + attr_accessor :impression_ratio + + # Serving priority of an ad, with respect to other ads. The lower the priority + # number, the greater the priority with which it is served. + # Corresponds to the JSON property `priority` + # @return [String] + attr_accessor :priority + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) + @hard_cutoff = args[:hard_cutoff] if args.key?(:hard_cutoff) + @impression_ratio = args[:impression_ratio] if args.key?(:impression_ratio) + @priority = args[:priority] if args.key?(:priority) + end + end + + # DFP Settings + class DfpSettings + include Google::Apis::Core::Hashable + + # DFP network code for this directory site. + # Corresponds to the JSON property `dfp_network_code` + # @return [String] + attr_accessor :dfp_network_code + + # DFP network name for this directory site. + # Corresponds to the JSON property `dfp_network_name` + # @return [String] + attr_accessor :dfp_network_name + + # Whether this directory site accepts programmatic placements. + # Corresponds to the JSON property `programmaticPlacementAccepted` + # @return [Boolean] + attr_accessor :programmatic_placement_accepted + alias_method :programmatic_placement_accepted?, :programmatic_placement_accepted + + # Whether this directory site accepts publisher-paid tags. + # Corresponds to the JSON property `pubPaidPlacementAccepted` + # @return [Boolean] + attr_accessor :pub_paid_placement_accepted + alias_method :pub_paid_placement_accepted?, :pub_paid_placement_accepted + + # Whether this directory site is available only via DoubleClick Publisher Portal. + # Corresponds to the JSON property `publisherPortalOnly` + # @return [Boolean] + attr_accessor :publisher_portal_only + alias_method :publisher_portal_only?, :publisher_portal_only + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dfp_network_code = args[:dfp_network_code] if args.key?(:dfp_network_code) + @dfp_network_name = args[:dfp_network_name] if args.key?(:dfp_network_name) + @programmatic_placement_accepted = args[:programmatic_placement_accepted] if args.key?(:programmatic_placement_accepted) + @pub_paid_placement_accepted = args[:pub_paid_placement_accepted] if args.key?(:pub_paid_placement_accepted) + @publisher_portal_only = args[:publisher_portal_only] if args.key?(:publisher_portal_only) + end + end + + # Represents a dimension. + class Dimension + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#dimension. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The dimension name, e.g. dfa:advertiser + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Represents a dimension filter. + class DimensionFilter + include Google::Apis::Core::Hashable + + # The name of the dimension to filter. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The kind of resource this is, in this case dfareporting#dimensionFilter. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The value of the dimension to filter. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @kind = args[:kind] if args.key?(:kind) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a DimensionValue resource. + class DimensionValue + include Google::Apis::Core::Hashable + + # The name of the dimension. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The ID associated with the value if available. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#dimensionValue. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Determines how the 'value' field is matched when filtering. If not specified, + # defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a + # placeholder for variable length character sequences, and it can be escaped + # with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow + # a matchType other than EXACT. + # Corresponds to the JSON property `matchType` + # @return [String] + attr_accessor :match_type + + # The value of the dimension. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @etag = args[:etag] if args.key?(:etag) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @match_type = args[:match_type] if args.key?(:match_type) + @value = args[:value] if args.key?(:value) + end + end + + # Represents the list of DimensionValue resources. + class DimensionValueList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The dimension values returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#dimensionValueList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through dimension values. To retrieve the next + # page of results, set the next request's "pageToken" to the value of this field. + # The page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents a DimensionValuesRequest. + class DimensionValueRequest + include Google::Apis::Core::Hashable + + # The name of the dimension for which values should be requested. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The end date of the date range for which to retrieve dimension values. A + # string of the format "yyyy-MM-dd". + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # The list of filters by which to filter values. The filters are ANDed. + # Corresponds to the JSON property `filters` + # @return [Array] + attr_accessor :filters + + # The kind of request this is, in this case dfareporting#dimensionValueRequest. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The start date of the date range for which to retrieve dimension values. A + # string of the format "yyyy-MM-dd". + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @end_date = args[:end_date] if args.key?(:end_date) + @filters = args[:filters] if args.key?(:filters) + @kind = args[:kind] if args.key?(:kind) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # DirectorySites contains properties of a website from the Site Directory. Sites + # need to be added to an account via the Sites resource before they can be + # assigned to a placement. + class DirectorySite + include Google::Apis::Core::Hashable + + # Whether this directory site is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Directory site contacts. + # Corresponds to the JSON property `contactAssignments` + # @return [Array] + attr_accessor :contact_assignments + + # Country ID of this directory site. + # Corresponds to the JSON property `countryId` + # @return [String] + attr_accessor :country_id + + # Currency ID of this directory site. + # Possible values are: + # - "1" for USD + # - "2" for GBP + # - "3" for ESP + # - "4" for SEK + # - "5" for CAD + # - "6" for JPY + # - "7" for DEM + # - "8" for AUD + # - "9" for FRF + # - "10" for ITL + # - "11" for DKK + # - "12" for NOK + # - "13" for FIM + # - "14" for ZAR + # - "15" for IEP + # - "16" for NLG + # - "17" for EUR + # - "18" for KRW + # - "19" for TWD + # - "20" for SGD + # - "21" for CNY + # - "22" for HKD + # - "23" for NZD + # - "24" for MYR + # - "25" for BRL + # - "26" for PTE + # - "27" for MXP + # - "28" for CLP + # - "29" for TRY + # - "30" for ARS + # - "31" for PEN + # - "32" for ILS + # - "33" for CHF + # - "34" for VEF + # - "35" for COP + # - "36" for GTQ + # - "37" for PLN + # - "39" for INR + # - "40" for THB + # - "41" for IDR + # - "42" for CZK + # - "43" for RON + # - "44" for HUF + # - "45" for RUB + # - "46" for AED + # - "47" for BGN + # - "48" for HRK + # Corresponds to the JSON property `currencyId` + # @return [String] + attr_accessor :currency_id + + # Description of this directory site. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ID of this directory site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Tag types for regular placements. + # Acceptable values are: + # - "STANDARD" + # - "IFRAME_JAVASCRIPT_INPAGE" + # - "INTERNAL_REDIRECT_INPAGE" + # - "JAVASCRIPT_INPAGE" + # Corresponds to the JSON property `inpageTagFormats` + # @return [Array] + attr_accessor :inpage_tag_formats + + # Tag types for interstitial placements. + # Acceptable values are: + # - "IFRAME_JAVASCRIPT_INTERSTITIAL" + # - "INTERNAL_REDIRECT_INTERSTITIAL" + # - "JAVASCRIPT_INTERSTITIAL" + # Corresponds to the JSON property `interstitialTagFormats` + # @return [Array] + attr_accessor :interstitial_tag_formats + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySite". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this directory site. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Parent directory site ID. + # Corresponds to the JSON property `parentId` + # @return [String] + attr_accessor :parent_id + + # Directory Site Settings + # Corresponds to the JSON property `settings` + # @return [Google::Apis::DfareportingV2_7::DirectorySiteSettings] + attr_accessor :settings + + # URL of this directory site. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @contact_assignments = args[:contact_assignments] if args.key?(:contact_assignments) + @country_id = args[:country_id] if args.key?(:country_id) + @currency_id = args[:currency_id] if args.key?(:currency_id) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @inpage_tag_formats = args[:inpage_tag_formats] if args.key?(:inpage_tag_formats) + @interstitial_tag_formats = args[:interstitial_tag_formats] if args.key?(:interstitial_tag_formats) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @parent_id = args[:parent_id] if args.key?(:parent_id) + @settings = args[:settings] if args.key?(:settings) + @url = args[:url] if args.key?(:url) + end + end + + # Contains properties of a Site Directory contact. + class DirectorySiteContact + include Google::Apis::Core::Hashable + + # Address of this directory site contact. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Email address of this directory site contact. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # First name of this directory site contact. + # Corresponds to the JSON property `firstName` + # @return [String] + attr_accessor :first_name + + # ID of this directory site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySiteContact". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Last name of this directory site contact. + # Corresponds to the JSON property `lastName` + # @return [String] + attr_accessor :last_name + + # Phone number of this directory site contact. + # Corresponds to the JSON property `phone` + # @return [String] + attr_accessor :phone + + # Directory site contact role. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # Title or designation of this directory site contact. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Directory site contact type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @email = args[:email] if args.key?(:email) + @first_name = args[:first_name] if args.key?(:first_name) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_name = args[:last_name] if args.key?(:last_name) + @phone = args[:phone] if args.key?(:phone) + @role = args[:role] if args.key?(:role) + @title = args[:title] if args.key?(:title) + @type = args[:type] if args.key?(:type) + end + end + + # Directory Site Contact Assignment + class DirectorySiteContactAssignment + include Google::Apis::Core::Hashable + + # ID of this directory site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `contactId` + # @return [String] + attr_accessor :contact_id + + # Visibility of this directory site contact assignment. When set to PUBLIC this + # contact assignment is visible to all account and agency users; when set to + # PRIVATE it is visible only to the site. + # Corresponds to the JSON property `visibility` + # @return [String] + attr_accessor :visibility + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contact_id = args[:contact_id] if args.key?(:contact_id) + @visibility = args[:visibility] if args.key?(:visibility) + end + end + + # Directory Site Contact List Response + class DirectorySiteContactsListResponse + include Google::Apis::Core::Hashable + + # Directory site contact collection + # Corresponds to the JSON property `directorySiteContacts` + # @return [Array] + attr_accessor :directory_site_contacts + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySiteContactsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @directory_site_contacts = args[:directory_site_contacts] if args.key?(:directory_site_contacts) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Directory Site Settings + class DirectorySiteSettings + include Google::Apis::Core::Hashable + + # Whether this directory site has disabled active view creatives. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # DFP Settings + # Corresponds to the JSON property `dfp_settings` + # @return [Google::Apis::DfareportingV2_7::DfpSettings] + attr_accessor :dfp_settings + + # Whether this site accepts in-stream video ads. + # Corresponds to the JSON property `instream_video_placement_accepted` + # @return [Boolean] + attr_accessor :instream_video_placement_accepted + alias_method :instream_video_placement_accepted?, :instream_video_placement_accepted + + # Whether this site accepts interstitial ads. + # Corresponds to the JSON property `interstitialPlacementAccepted` + # @return [Boolean] + attr_accessor :interstitial_placement_accepted + alias_method :interstitial_placement_accepted?, :interstitial_placement_accepted + + # Whether this directory site has disabled Nielsen OCR reach ratings. + # Corresponds to the JSON property `nielsenOcrOptOut` + # @return [Boolean] + attr_accessor :nielsen_ocr_opt_out + alias_method :nielsen_ocr_opt_out?, :nielsen_ocr_opt_out + + # Whether this directory site has disabled generation of Verification ins tags. + # Corresponds to the JSON property `verificationTagOptOut` + # @return [Boolean] + attr_accessor :verification_tag_opt_out + alias_method :verification_tag_opt_out?, :verification_tag_opt_out + + # Whether this directory site has disabled active view for in-stream video + # creatives. + # Corresponds to the JSON property `videoActiveViewOptOut` + # @return [Boolean] + attr_accessor :video_active_view_opt_out + alias_method :video_active_view_opt_out?, :video_active_view_opt_out + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @dfp_settings = args[:dfp_settings] if args.key?(:dfp_settings) + @instream_video_placement_accepted = args[:instream_video_placement_accepted] if args.key?(:instream_video_placement_accepted) + @interstitial_placement_accepted = args[:interstitial_placement_accepted] if args.key?(:interstitial_placement_accepted) + @nielsen_ocr_opt_out = args[:nielsen_ocr_opt_out] if args.key?(:nielsen_ocr_opt_out) + @verification_tag_opt_out = args[:verification_tag_opt_out] if args.key?(:verification_tag_opt_out) + @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) + end + end + + # Directory Site List Response + class DirectorySitesListResponse + include Google::Apis::Core::Hashable + + # Directory site collection. + # Corresponds to the JSON property `directorySites` + # @return [Array] + attr_accessor :directory_sites + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySitesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @directory_sites = args[:directory_sites] if args.key?(:directory_sites) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a dynamic targeting key. Dynamic targeting keys are + # unique, user-friendly labels, created at the advertiser level in DCM, that can + # be assigned to ads, creatives, and placements and used for targeting with + # DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM + # IDs (such as placement IDs) to save time and avoid errors in your dynamic + # feeds. + class DynamicTargetingKey + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#dynamicTargetingKey". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this dynamic targeting key. This is a required field. Must be less + # than 256 characters long and cannot contain commas. All characters are + # converted to lowercase. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the object of this dynamic targeting key. This is a required field. + # Corresponds to the JSON property `objectId` + # @return [String] + attr_accessor :object_id_prop + + # Type of the object of this dynamic targeting key. This is a required field. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @object_type = args[:object_type] if args.key?(:object_type) + end + end + + # Dynamic Targeting Key List Response + class DynamicTargetingKeysListResponse + include Google::Apis::Core::Hashable + + # Dynamic targeting key collection. + # Corresponds to the JSON property `dynamicTargetingKeys` + # @return [Array] + attr_accessor :dynamic_targeting_keys + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#dynamicTargetingKeysListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dynamic_targeting_keys = args[:dynamic_targeting_keys] if args.key?(:dynamic_targeting_keys) + @kind = args[:kind] if args.key?(:kind) + end + end + + # A description of how user IDs are encrypted. + class EncryptionInfo + include Google::Apis::Core::Hashable + + # The encryption entity ID. This should match the encryption configuration for + # ad serving or Data Transfer. + # Corresponds to the JSON property `encryptionEntityId` + # @return [String] + attr_accessor :encryption_entity_id + + # The encryption entity type. This should match the encryption configuration for + # ad serving or Data Transfer. + # Corresponds to the JSON property `encryptionEntityType` + # @return [String] + attr_accessor :encryption_entity_type + + # Describes whether the encrypted cookie was received from ad serving (the %m + # macro) or from Data Transfer. + # Corresponds to the JSON property `encryptionSource` + # @return [String] + attr_accessor :encryption_source + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#encryptionInfo". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @encryption_entity_id = args[:encryption_entity_id] if args.key?(:encryption_entity_id) + @encryption_entity_type = args[:encryption_entity_type] if args.key?(:encryption_entity_type) + @encryption_source = args[:encryption_source] if args.key?(:encryption_source) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of an event tag. + class EventTag + include Google::Apis::Core::Hashable + + # Account ID of this event tag. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this event tag. This field or the campaignId field is + # required on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Campaign ID of this event tag. This field or the advertiserId field is + # required on insertion. + # Corresponds to the JSON property `campaignId` + # @return [String] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Whether this event tag should be automatically enabled for all of the + # advertiser's campaigns and ads. + # Corresponds to the JSON property `enabledByDefault` + # @return [Boolean] + attr_accessor :enabled_by_default + alias_method :enabled_by_default?, :enabled_by_default + + # Whether to remove this event tag from ads that are trafficked through + # DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag + # uses a pixel that is unapproved for Ad Exchange bids on one or more networks, + # such as the Google Display Network. + # Corresponds to the JSON property `excludeFromAdxRequests` + # @return [Boolean] + attr_accessor :exclude_from_adx_requests + alias_method :exclude_from_adx_requests?, :exclude_from_adx_requests + + # ID of this event tag. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#eventTag". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this event tag. This is a required field and must be less than 256 + # characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Site filter type for this event tag. If no type is specified then the event + # tag will be applied to all sites. + # Corresponds to the JSON property `siteFilterType` + # @return [String] + attr_accessor :site_filter_type + + # Filter list of site IDs associated with this event tag. The siteFilterType + # determines whether this is a whitelist or blacklist filter. + # Corresponds to the JSON property `siteIds` + # @return [Array] + attr_accessor :site_ids + + # Whether this tag is SSL-compliant or not. This is a read-only field. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Status of this event tag. Must be ENABLED for this event tag to fire. This is + # a required field. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this event tag. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Event tag type. Can be used to specify whether to use a third-party pixel, a + # third-party JavaScript URL, or a third-party click-through URL for either + # impression or click tracking. This is a required field. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Payload URL for this event tag. The URL on a click-through event tag should + # have a landing page URL appended to the end of it. This field is required on + # insertion. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + # Number of times the landing page URL should be URL-escaped before being + # appended to the click-through event tag URL. Only applies to click-through + # event tags as specified by the event tag type. + # Corresponds to the JSON property `urlEscapeLevels` + # @return [Fixnum] + attr_accessor :url_escape_levels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @enabled_by_default = args[:enabled_by_default] if args.key?(:enabled_by_default) + @exclude_from_adx_requests = args[:exclude_from_adx_requests] if args.key?(:exclude_from_adx_requests) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @site_filter_type = args[:site_filter_type] if args.key?(:site_filter_type) + @site_ids = args[:site_ids] if args.key?(:site_ids) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @type = args[:type] if args.key?(:type) + @url = args[:url] if args.key?(:url) + @url_escape_levels = args[:url_escape_levels] if args.key?(:url_escape_levels) + end + end + + # Event tag override information. + class EventTagOverride + include Google::Apis::Core::Hashable + + # Whether this override is enabled. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # ID of this event tag override. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + @id = args[:id] if args.key?(:id) + end + end + + # Event Tag List Response + class EventTagsListResponse + include Google::Apis::Core::Hashable + + # Event tag collection. + # Corresponds to the JSON property `eventTags` + # @return [Array] + attr_accessor :event_tags + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#eventTagsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @event_tags = args[:event_tags] if args.key?(:event_tags) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a File resource. A file contains the metadata for a report run. It + # shows the status of the run and holds the URLs to the generated report data if + # the run is finished and the status is "REPORT_AVAILABLE". + class File + include Google::Apis::Core::Hashable + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The filename of the file. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + # The output format of the report. Only available once the file is available. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # The unique ID of this report file. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#file. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The timestamp in milliseconds since epoch when this file was last modified. + # Corresponds to the JSON property `lastModifiedTime` + # @return [String] + attr_accessor :last_modified_time + + # The ID of the report this file was generated from. + # Corresponds to the JSON property `reportId` + # @return [String] + attr_accessor :report_id + + # The status of the report file. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # The URLs where the completed report file can be downloaded. + # Corresponds to the JSON property `urls` + # @return [Google::Apis::DfareportingV2_7::File::Urls] + attr_accessor :urls + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date_range = args[:date_range] if args.key?(:date_range) + @etag = args[:etag] if args.key?(:etag) + @file_name = args[:file_name] if args.key?(:file_name) + @format = args[:format] if args.key?(:format) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) + @report_id = args[:report_id] if args.key?(:report_id) + @status = args[:status] if args.key?(:status) + @urls = args[:urls] if args.key?(:urls) + end + + # The URLs where the completed report file can be downloaded. + class Urls + include Google::Apis::Core::Hashable + + # The URL for downloading the report data through the API. + # Corresponds to the JSON property `apiUrl` + # @return [String] + attr_accessor :api_url + + # The URL for downloading the report data through a browser. + # Corresponds to the JSON property `browserUrl` + # @return [String] + attr_accessor :browser_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_url = args[:api_url] if args.key?(:api_url) + @browser_url = args[:browser_url] if args.key?(:browser_url) + end + end + end + + # Represents the list of File resources. + class FileList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The files returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#fileList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through files. To retrieve the next page of + # results, set the next request's "pageToken" to the value of this field. The + # page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Flight + class Flight + include Google::Apis::Core::Hashable + + # Inventory item flight end date. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Rate or cost of this flight. + # Corresponds to the JSON property `rateOrCost` + # @return [String] + attr_accessor :rate_or_cost + + # Inventory item flight start date. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Units of this flight. + # Corresponds to the JSON property `units` + # @return [String] + attr_accessor :units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @rate_or_cost = args[:rate_or_cost] if args.key?(:rate_or_cost) + @start_date = args[:start_date] if args.key?(:start_date) + @units = args[:units] if args.key?(:units) + end + end + + # Floodlight Activity GenerateTag Response + class FloodlightActivitiesGenerateTagResponse + include Google::Apis::Core::Hashable + + # Generated tag for this floodlight activity. + # Corresponds to the JSON property `floodlightActivityTag` + # @return [String] + attr_accessor :floodlight_activity_tag + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivitiesGenerateTagResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_tag = args[:floodlight_activity_tag] if args.key?(:floodlight_activity_tag) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Floodlight Activity List Response + class FloodlightActivitiesListResponse + include Google::Apis::Core::Hashable + + # Floodlight activity collection. + # Corresponds to the JSON property `floodlightActivities` + # @return [Array] + attr_accessor :floodlight_activities + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivitiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activities = args[:floodlight_activities] if args.key?(:floodlight_activities) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a Floodlight activity. + class FloodlightActivity + include Google::Apis::Core::Hashable + + # Account ID of this floodlight activity. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this floodlight activity. If this field is left blank, the + # value will be copied over either from the activity group's advertiser or the + # existing activity's advertiser. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Code type used for cache busting in the generated tag. + # Corresponds to the JSON property `cacheBustingType` + # @return [String] + attr_accessor :cache_busting_type + + # Counting method for conversions for this floodlight activity. This is a + # required field. + # Corresponds to the JSON property `countingMethod` + # @return [String] + attr_accessor :counting_method + + # Dynamic floodlight tags. + # Corresponds to the JSON property `defaultTags` + # @return [Array] + attr_accessor :default_tags + + # URL where this tag will be deployed. If specified, must be less than 256 + # characters long. + # Corresponds to the JSON property `expectedUrl` + # @return [String] + attr_accessor :expected_url + + # Floodlight activity group ID of this floodlight activity. This is a required + # field. + # Corresponds to the JSON property `floodlightActivityGroupId` + # @return [String] + attr_accessor :floodlight_activity_group_id + + # Name of the associated floodlight activity group. This is a read-only field. + # Corresponds to the JSON property `floodlightActivityGroupName` + # @return [String] + attr_accessor :floodlight_activity_group_name + + # Tag string of the associated floodlight activity group. This is a read-only + # field. + # Corresponds to the JSON property `floodlightActivityGroupTagString` + # @return [String] + attr_accessor :floodlight_activity_group_tag_string + + # Type of the associated floodlight activity group. This is a read-only field. + # Corresponds to the JSON property `floodlightActivityGroupType` + # @return [String] + attr_accessor :floodlight_activity_group_type + + # Floodlight configuration ID of this floodlight activity. If this field is left + # blank, the value will be copied over either from the activity group's + # floodlight configuration or from the existing activity's floodlight + # configuration. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [String] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # Whether this activity is archived. + # Corresponds to the JSON property `hidden` + # @return [Boolean] + attr_accessor :hidden + alias_method :hidden?, :hidden + + # ID of this floodlight activity. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Whether the image tag is enabled for this activity. + # Corresponds to the JSON property `imageTagEnabled` + # @return [Boolean] + attr_accessor :image_tag_enabled + alias_method :image_tag_enabled?, :image_tag_enabled + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivity". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this floodlight activity. This is a required field. Must be less than + # 129 characters long and cannot contain quotes. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # General notes or implementation instructions for the tag. + # Corresponds to the JSON property `notes` + # @return [String] + attr_accessor :notes + + # Publisher dynamic floodlight tags. + # Corresponds to the JSON property `publisherTags` + # @return [Array] + attr_accessor :publisher_tags + + # Whether this tag should use SSL. + # Corresponds to the JSON property `secure` + # @return [Boolean] + attr_accessor :secure + alias_method :secure?, :secure + + # Whether the floodlight activity is SSL-compliant. This is a read-only field, + # its value detected by the system from the floodlight tags. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether this floodlight activity must be SSL-compliant. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Subaccount ID of this floodlight activity. This is a read-only field that can + # be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Tag format type for the floodlight activity. If left blank, the tag format + # will default to HTML. + # Corresponds to the JSON property `tagFormat` + # @return [String] + attr_accessor :tag_format + + # Value of the cat= paramter in the floodlight tag, which the ad servers use to + # identify the activity. This is optional: if empty, a new tag string will be + # generated for you. This string must be 1 to 8 characters long, with valid + # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique + # among activities of the same activity group. This field is read-only after + # insertion. + # Corresponds to the JSON property `tagString` + # @return [String] + attr_accessor :tag_string + + # List of the user-defined variables used by this conversion tag. These map to + # the "u[1-20]=" in the tags. Each of these can have a user defined type. + # Acceptable values are: + # - "U1" + # - "U2" + # - "U3" + # - "U4" + # - "U5" + # - "U6" + # - "U7" + # - "U8" + # - "U9" + # - "U10" + # - "U11" + # - "U12" + # - "U13" + # - "U14" + # - "U15" + # - "U16" + # - "U17" + # - "U18" + # - "U19" + # - "U20" + # Corresponds to the JSON property `userDefinedVariableTypes` + # @return [Array] + attr_accessor :user_defined_variable_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @cache_busting_type = args[:cache_busting_type] if args.key?(:cache_busting_type) + @counting_method = args[:counting_method] if args.key?(:counting_method) + @default_tags = args[:default_tags] if args.key?(:default_tags) + @expected_url = args[:expected_url] if args.key?(:expected_url) + @floodlight_activity_group_id = args[:floodlight_activity_group_id] if args.key?(:floodlight_activity_group_id) + @floodlight_activity_group_name = args[:floodlight_activity_group_name] if args.key?(:floodlight_activity_group_name) + @floodlight_activity_group_tag_string = args[:floodlight_activity_group_tag_string] if args.key?(:floodlight_activity_group_tag_string) + @floodlight_activity_group_type = args[:floodlight_activity_group_type] if args.key?(:floodlight_activity_group_type) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @hidden = args[:hidden] if args.key?(:hidden) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @notes = args[:notes] if args.key?(:notes) + @publisher_tags = args[:publisher_tags] if args.key?(:publisher_tags) + @secure = args[:secure] if args.key?(:secure) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_format = args[:tag_format] if args.key?(:tag_format) + @tag_string = args[:tag_string] if args.key?(:tag_string) + @user_defined_variable_types = args[:user_defined_variable_types] if args.key?(:user_defined_variable_types) + end + end + + # Dynamic Tag + class FloodlightActivityDynamicTag + include Google::Apis::Core::Hashable + + # ID of this dynamic tag. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Name of this tag. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Tag code. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @tag = args[:tag] if args.key?(:tag) + end + end + + # Contains properties of a Floodlight activity group. + class FloodlightActivityGroup + include Google::Apis::Core::Hashable + + # Account ID of this floodlight activity group. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this floodlight activity group. If this field is left blank, + # the value will be copied over either from the floodlight configuration's + # advertiser or from the existing activity group's advertiser. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Floodlight configuration ID of this floodlight activity group. This is a + # required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [String] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # ID of this floodlight activity group. This is a read-only, auto-generated + # field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivityGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this floodlight activity group. This is a required field. Must be less + # than 65 characters long and cannot contain quotes. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this floodlight activity group. This is a read-only field + # that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Value of the type= parameter in the floodlight tag, which the ad servers use + # to identify the activity group that the activity belongs to. This is optional: + # if empty, a new tag string will be generated for you. This string must be 1 to + # 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This + # tag string must also be unique among activity groups of the same floodlight + # configuration. This field is read-only after insertion. + # Corresponds to the JSON property `tagString` + # @return [String] + attr_accessor :tag_string + + # Type of the floodlight activity group. This is a required field that is read- + # only after insertion. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_string = args[:tag_string] if args.key?(:tag_string) + @type = args[:type] if args.key?(:type) + end + end + + # Floodlight Activity Group List Response + class FloodlightActivityGroupsListResponse + include Google::Apis::Core::Hashable + + # Floodlight activity group collection. + # Corresponds to the JSON property `floodlightActivityGroups` + # @return [Array] + attr_accessor :floodlight_activity_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivityGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_groups = args[:floodlight_activity_groups] if args.key?(:floodlight_activity_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Publisher Dynamic Tag + class FloodlightActivityPublisherDynamicTag + include Google::Apis::Core::Hashable + + # Whether this tag is applicable only for click-throughs. + # Corresponds to the JSON property `clickThrough` + # @return [Boolean] + attr_accessor :click_through + alias_method :click_through?, :click_through + + # Directory site ID of this dynamic tag. This is a write-only field that can be + # used as an alternative to the siteId field. When this resource is retrieved, + # only the siteId field will be populated. + # Corresponds to the JSON property `directorySiteId` + # @return [String] + attr_accessor :directory_site_id + + # Dynamic Tag + # Corresponds to the JSON property `dynamicTag` + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityDynamicTag] + attr_accessor :dynamic_tag + + # Site ID of this dynamic tag. + # Corresponds to the JSON property `siteId` + # @return [String] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :site_id_dimension_value + + # Whether this tag is applicable only for view-throughs. + # Corresponds to the JSON property `viewThrough` + # @return [Boolean] + attr_accessor :view_through + alias_method :view_through?, :view_through + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through = args[:click_through] if args.key?(:click_through) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @dynamic_tag = args[:dynamic_tag] if args.key?(:dynamic_tag) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @view_through = args[:view_through] if args.key?(:view_through) + end + end + + # Contains properties of a Floodlight configuration. + class FloodlightConfiguration + include Google::Apis::Core::Hashable + + # Account ID of this floodlight configuration. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of the parent advertiser of this floodlight configuration. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether advertiser data is shared with Google Analytics. + # Corresponds to the JSON property `analyticsDataSharingEnabled` + # @return [Boolean] + attr_accessor :analytics_data_sharing_enabled + alias_method :analytics_data_sharing_enabled?, :analytics_data_sharing_enabled + + # Whether the exposure-to-conversion report is enabled. This report shows + # detailed pathway information on up to 10 of the most recent ad exposures seen + # by a user before converting. + # Corresponds to the JSON property `exposureToConversionEnabled` + # @return [Boolean] + attr_accessor :exposure_to_conversion_enabled + alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled + + # Day that will be counted as the first day of the week in reports. This is a + # required field. + # Corresponds to the JSON property `firstDayOfWeek` + # @return [String] + attr_accessor :first_day_of_week + + # ID of this floodlight configuration. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Whether in-app attribution tracking is enabled. + # Corresponds to the JSON property `inAppAttributionTrackingEnabled` + # @return [Boolean] + attr_accessor :in_app_attribution_tracking_enabled + alias_method :in_app_attribution_tracking_enabled?, :in_app_attribution_tracking_enabled + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightConfiguration". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV2_7::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Types of attribution options for natural search conversions. + # Corresponds to the JSON property `naturalSearchConversionAttributionOption` + # @return [String] + attr_accessor :natural_search_conversion_attribution_option + + # Omniture Integration Settings. + # Corresponds to the JSON property `omnitureSettings` + # @return [Google::Apis::DfareportingV2_7::OmnitureSettings] + attr_accessor :omniture_settings + + # List of standard variables enabled for this configuration. + # Acceptable values are: + # - "ORD" + # - "NUM" + # Corresponds to the JSON property `standardVariableTypes` + # @return [Array] + attr_accessor :standard_variable_types + + # Subaccount ID of this floodlight configuration. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Dynamic and Image Tag Settings. + # Corresponds to the JSON property `tagSettings` + # @return [Google::Apis::DfareportingV2_7::TagSettings] + attr_accessor :tag_settings + + # List of third-party authentication tokens enabled for this configuration. + # Corresponds to the JSON property `thirdPartyAuthenticationTokens` + # @return [Array] + attr_accessor :third_party_authentication_tokens + + # List of user defined variables enabled for this configuration. + # Corresponds to the JSON property `userDefinedVariableConfigurations` + # @return [Array] + attr_accessor :user_defined_variable_configurations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @analytics_data_sharing_enabled = args[:analytics_data_sharing_enabled] if args.key?(:analytics_data_sharing_enabled) + @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) + @first_day_of_week = args[:first_day_of_week] if args.key?(:first_day_of_week) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @in_app_attribution_tracking_enabled = args[:in_app_attribution_tracking_enabled] if args.key?(:in_app_attribution_tracking_enabled) + @kind = args[:kind] if args.key?(:kind) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @natural_search_conversion_attribution_option = args[:natural_search_conversion_attribution_option] if args.key?(:natural_search_conversion_attribution_option) + @omniture_settings = args[:omniture_settings] if args.key?(:omniture_settings) + @standard_variable_types = args[:standard_variable_types] if args.key?(:standard_variable_types) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_settings = args[:tag_settings] if args.key?(:tag_settings) + @third_party_authentication_tokens = args[:third_party_authentication_tokens] if args.key?(:third_party_authentication_tokens) + @user_defined_variable_configurations = args[:user_defined_variable_configurations] if args.key?(:user_defined_variable_configurations) + end + end + + # Floodlight Configuration List Response + class FloodlightConfigurationsListResponse + include Google::Apis::Core::Hashable + + # Floodlight configuration collection. + # Corresponds to the JSON property `floodlightConfigurations` + # @return [Array] + attr_accessor :floodlight_configurations + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightConfigurationsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_configurations = args[:floodlight_configurations] if args.key?(:floodlight_configurations) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # FlOODLIGHT". + class FloodlightReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting# + # floodlightReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + end + end + + # Frequency Cap. + class FrequencyCap + include Google::Apis::Core::Hashable + + # Duration of time, in seconds, for this frequency cap. The maximum duration is + # 90 days in seconds, or 7,776,000. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Number of times an individual user can be served the ad within the specified + # duration. The maximum allowed is 15. + # Corresponds to the JSON property `impressions` + # @return [String] + attr_accessor :impressions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @impressions = args[:impressions] if args.key?(:impressions) + end + end + + # FsCommand. + class FsCommand + include Google::Apis::Core::Hashable + + # Distance from the left of the browser.Applicable when positionOption is + # DISTANCE_FROM_TOP_LEFT_CORNER. + # Corresponds to the JSON property `left` + # @return [Fixnum] + attr_accessor :left + + # Position in the browser where the window will open. + # Corresponds to the JSON property `positionOption` + # @return [String] + attr_accessor :position_option + + # Distance from the top of the browser. Applicable when positionOption is + # DISTANCE_FROM_TOP_LEFT_CORNER. + # Corresponds to the JSON property `top` + # @return [Fixnum] + attr_accessor :top + + # Height of the window. + # Corresponds to the JSON property `windowHeight` + # @return [Fixnum] + attr_accessor :window_height + + # Width of the window. + # Corresponds to the JSON property `windowWidth` + # @return [Fixnum] + attr_accessor :window_width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @left = args[:left] if args.key?(:left) + @position_option = args[:position_option] if args.key?(:position_option) + @top = args[:top] if args.key?(:top) + @window_height = args[:window_height] if args.key?(:window_height) + @window_width = args[:window_width] if args.key?(:window_width) + end + end + + # Geographical Targeting. + class GeoTargeting + include Google::Apis::Core::Hashable + + # Cities to be targeted. For each city only dartId is required. The other fields + # are populated automatically when the ad is inserted or updated. If targeting a + # city, do not target or exclude the country of the city, and do not target the + # metro or region of the city. + # Corresponds to the JSON property `cities` + # @return [Array] + attr_accessor :cities + + # Countries to be targeted or excluded from targeting, depending on the setting + # of the excludeCountries field. For each country only dartId is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting or excluding a country, do not target regions, cities, metros, or + # postal codes in the same country. + # Corresponds to the JSON property `countries` + # @return [Array] + attr_accessor :countries + + # Whether or not to exclude the countries in the countries field from targeting. + # If false, the countries field refers to countries which will be targeted by + # the ad. + # Corresponds to the JSON property `excludeCountries` + # @return [Boolean] + attr_accessor :exclude_countries + alias_method :exclude_countries?, :exclude_countries + + # Metros to be targeted. For each metro only dmaId is required. The other fields + # are populated automatically when the ad is inserted or updated. If targeting a + # metro, do not target or exclude the country of the metro. + # Corresponds to the JSON property `metros` + # @return [Array] + attr_accessor :metros + + # Postal codes to be targeted. For each postal code only id is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting a postal code, do not target or exclude the country of the postal + # code. + # Corresponds to the JSON property `postalCodes` + # @return [Array] + attr_accessor :postal_codes + + # Regions to be targeted. For each region only dartId is required. The other + # fields are populated automatically when the ad is inserted or updated. If + # targeting a region, do not target or exclude the country of the region. + # Corresponds to the JSON property `regions` + # @return [Array] + attr_accessor :regions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cities = args[:cities] if args.key?(:cities) + @countries = args[:countries] if args.key?(:countries) + @exclude_countries = args[:exclude_countries] if args.key?(:exclude_countries) + @metros = args[:metros] if args.key?(:metros) + @postal_codes = args[:postal_codes] if args.key?(:postal_codes) + @regions = args[:regions] if args.key?(:regions) + end + end + + # Represents a buy from the DoubleClick Planning inventory store. + class InventoryItem + include Google::Apis::Core::Hashable + + # Account ID of this inventory item. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Ad slots of this inventory item. If this inventory item represents a + # standalone placement, there will be exactly one ad slot. If this inventory + # item represents a placement group, there will be more than one ad slot, each + # representing one child placement in that placement group. + # Corresponds to the JSON property `adSlots` + # @return [Array] + attr_accessor :ad_slots + + # Advertiser ID of this inventory item. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Content category ID of this inventory item. + # Corresponds to the JSON property `contentCategoryId` + # @return [String] + attr_accessor :content_category_id + + # Estimated click-through rate of this inventory item. + # Corresponds to the JSON property `estimatedClickThroughRate` + # @return [String] + attr_accessor :estimated_click_through_rate + + # Estimated conversion rate of this inventory item. + # Corresponds to the JSON property `estimatedConversionRate` + # @return [String] + attr_accessor :estimated_conversion_rate + + # ID of this inventory item. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Whether this inventory item is in plan. + # Corresponds to the JSON property `inPlan` + # @return [Boolean] + attr_accessor :in_plan + alias_method :in_plan?, :in_plan + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#inventoryItem". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this inventory item. For standalone inventory items, this is the same + # name as that of its only ad slot. For group inventory items, this can differ + # from the name of any of its ad slots. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Negotiation channel ID of this inventory item. + # Corresponds to the JSON property `negotiationChannelId` + # @return [String] + attr_accessor :negotiation_channel_id + + # Order ID of this inventory item. + # Corresponds to the JSON property `orderId` + # @return [String] + attr_accessor :order_id + + # Placement strategy ID of this inventory item. + # Corresponds to the JSON property `placementStrategyId` + # @return [String] + attr_accessor :placement_strategy_id + + # Pricing Information + # Corresponds to the JSON property `pricing` + # @return [Google::Apis::DfareportingV2_7::Pricing] + attr_accessor :pricing + + # Project ID of this inventory item. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # RFP ID of this inventory item. + # Corresponds to the JSON property `rfpId` + # @return [String] + attr_accessor :rfp_id + + # ID of the site this inventory item is associated with. + # Corresponds to the JSON property `siteId` + # @return [String] + attr_accessor :site_id + + # Subaccount ID of this inventory item. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Type of inventory item. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @ad_slots = args[:ad_slots] if args.key?(:ad_slots) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @estimated_click_through_rate = args[:estimated_click_through_rate] if args.key?(:estimated_click_through_rate) + @estimated_conversion_rate = args[:estimated_conversion_rate] if args.key?(:estimated_conversion_rate) + @id = args[:id] if args.key?(:id) + @in_plan = args[:in_plan] if args.key?(:in_plan) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @negotiation_channel_id = args[:negotiation_channel_id] if args.key?(:negotiation_channel_id) + @order_id = args[:order_id] if args.key?(:order_id) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing = args[:pricing] if args.key?(:pricing) + @project_id = args[:project_id] if args.key?(:project_id) + @rfp_id = args[:rfp_id] if args.key?(:rfp_id) + @site_id = args[:site_id] if args.key?(:site_id) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @type = args[:type] if args.key?(:type) + end + end + + # Inventory item List Response + class InventoryItemsListResponse + include Google::Apis::Core::Hashable + + # Inventory item collection + # Corresponds to the JSON property `inventoryItems` + # @return [Array] + attr_accessor :inventory_items + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#inventoryItemsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inventory_items = args[:inventory_items] if args.key?(:inventory_items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Key Value Targeting Expression. + class KeyValueTargetingExpression + include Google::Apis::Core::Hashable + + # Keyword expression being targeted by the ad. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression = args[:expression] if args.key?(:expression) + end + end + + # Contains information about where a user's browser is taken after the user + # clicks an ad. + class LandingPage + include Google::Apis::Core::Hashable + + # Whether or not this landing page will be assigned to any ads or creatives that + # do not have a landing page assigned explicitly. Only one default landing page + # is allowed per campaign. + # Corresponds to the JSON property `default` + # @return [Boolean] + attr_accessor :default + alias_method :default?, :default + + # ID of this landing page. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#landingPage". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this landing page. This is a required field. It must be less than 256 + # characters long, and must be unique among landing pages of the same campaign. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # URL of this landing page. This is a required field. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default = args[:default] if args.key?(:default) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @url = args[:url] if args.key?(:url) + end + end + + # Landing Page List Response + class LandingPagesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#landingPagesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Landing page collection + # Corresponds to the JSON property `landingPages` + # @return [Array] + attr_accessor :landing_pages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @landing_pages = args[:landing_pages] if args.key?(:landing_pages) + end + end + + # Contains information about a language that can be targeted by ads. + class Language + include Google::Apis::Core::Hashable + + # Language ID of this language. This is the ID used for targeting and generating + # reports. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#language". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Format of language code is an ISO 639 two-letter language code optionally + # followed by an underscore followed by an ISO 3166 code. Examples are "en" for + # English or "zh_CN" for Simplified Chinese. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Name of this language. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @language_code = args[:language_code] if args.key?(:language_code) + @name = args[:name] if args.key?(:name) + end + end + + # Language Targeting. + class LanguageTargeting + include Google::Apis::Core::Hashable + + # Languages that this ad targets. For each language only languageId is required. + # The other fields are populated automatically when the ad is inserted or + # updated. + # Corresponds to the JSON property `languages` + # @return [Array] + attr_accessor :languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @languages = args[:languages] if args.key?(:languages) + end + end + + # Language List Response + class LanguagesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#languagesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language collection. + # Corresponds to the JSON property `languages` + # @return [Array] + attr_accessor :languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @languages = args[:languages] if args.key?(:languages) + end + end + + # Modification timestamp. + class LastModifiedInfo + include Google::Apis::Core::Hashable + + # Timestamp of the last change in milliseconds since epoch. + # Corresponds to the JSON property `time` + # @return [String] + attr_accessor :time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time = args[:time] if args.key?(:time) + end + end + + # A group clause made up of list population terms representing constraints + # joined by ORs. + class ListPopulationClause + include Google::Apis::Core::Hashable + + # Terms of this list population clause. Each clause is made up of list + # population terms representing constraints and are joined by ORs. + # Corresponds to the JSON property `terms` + # @return [Array] + attr_accessor :terms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @terms = args[:terms] if args.key?(:terms) + end + end + + # Remarketing List Population Rule. + class ListPopulationRule + include Google::Apis::Core::Hashable + + # Floodlight activity ID associated with this rule. This field can be left blank. + # Corresponds to the JSON property `floodlightActivityId` + # @return [String] + attr_accessor :floodlight_activity_id + + # Name of floodlight activity associated with this rule. This is a read-only, + # auto-generated field. + # Corresponds to the JSON property `floodlightActivityName` + # @return [String] + attr_accessor :floodlight_activity_name + + # Clauses that make up this list population rule. Clauses are joined by ANDs, + # and the clauses themselves are made up of list population terms which are + # joined by ORs. + # Corresponds to the JSON property `listPopulationClauses` + # @return [Array] + attr_accessor :list_population_clauses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_activity_name = args[:floodlight_activity_name] if args.key?(:floodlight_activity_name) + @list_population_clauses = args[:list_population_clauses] if args.key?(:list_population_clauses) + end + end + + # Remarketing List Population Rule Term. + class ListPopulationTerm + include Google::Apis::Core::Hashable + + # Will be true if the term should check if the user is in the list and false if + # the term should check if the user is not in the list. This field is only + # relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. + # Corresponds to the JSON property `contains` + # @return [Boolean] + attr_accessor :contains + alias_method :contains?, :contains + + # Whether to negate the comparison result of this term during rule evaluation. + # This field is only relevant when type is left unset or set to + # CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `negation` + # @return [Boolean] + attr_accessor :negation + alias_method :negation?, :negation + + # Comparison operator of this term. This field is only relevant when type is + # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `operator` + # @return [String] + attr_accessor :operator + + # ID of the list in question. This field is only relevant when type is set to + # LIST_MEMBERSHIP_TERM. + # Corresponds to the JSON property `remarketingListId` + # @return [String] + attr_accessor :remarketing_list_id + + # List population term type determines the applicable fields in this object. If + # left unset or set to CUSTOM_VARIABLE_TERM, then variableName, + # variableFriendlyName, operator, value, and negation are applicable. If set to + # LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If + # set to REFERRER_TERM then operator, value, and negation are applicable. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Literal to compare the variable to. This field is only relevant when type is + # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + # Friendly name of this term's variable. This is a read-only, auto-generated + # field. This field is only relevant when type is left unset or set to + # CUSTOM_VARIABLE_TERM. + # Corresponds to the JSON property `variableFriendlyName` + # @return [String] + attr_accessor :variable_friendly_name + + # Name of the variable (U1, U2, etc.) being compared in this term. This field is + # only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `variableName` + # @return [String] + attr_accessor :variable_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contains = args[:contains] if args.key?(:contains) + @negation = args[:negation] if args.key?(:negation) + @operator = args[:operator] if args.key?(:operator) + @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name) + @variable_name = args[:variable_name] if args.key?(:variable_name) + end + end + + # Remarketing List Targeting Expression. + class ListTargetingExpression + include Google::Apis::Core::Hashable + + # Expression describing which lists are being targeted by the ad. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression = args[:expression] if args.key?(:expression) + end + end + + # Lookback configuration settings. + class LookbackConfiguration + include Google::Apis::Core::Hashable + + # Lookback window, in days, from the last time a given user clicked on one of + # your ads. If you enter 0, clicks will not be considered as triggering events + # for floodlight tracking. If you leave this field blank, the default value for + # your account will be used. + # Corresponds to the JSON property `clickDuration` + # @return [Fixnum] + attr_accessor :click_duration + + # Lookback window, in days, from the last time a given user viewed one of your + # ads. If you enter 0, impressions will not be considered as triggering events + # for floodlight tracking. If you leave this field blank, the default value for + # your account will be used. + # Corresponds to the JSON property `postImpressionActivitiesDuration` + # @return [Fixnum] + attr_accessor :post_impression_activities_duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_duration = args[:click_duration] if args.key?(:click_duration) + @post_impression_activities_duration = args[:post_impression_activities_duration] if args.key?(:post_impression_activities_duration) + end + end + + # Represents a metric. + class Metric + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#metric. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The metric name, e.g. dfa:impressions + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a metro region that can be targeted by ads. + class Metro + include Google::Apis::Core::Hashable + + # Country code of the country to which this metro region belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this metro region belongs. + # Corresponds to the JSON property `countryDartId` + # @return [String] + attr_accessor :country_dart_id + + # DART ID of this metro region. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # DMA ID of this metro region. This is the ID used for targeting and generating + # reports, and is equivalent to metro_code. + # Corresponds to the JSON property `dmaId` + # @return [String] + attr_accessor :dma_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#metro". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro code of this metro region. This is equivalent to dma_id. + # Corresponds to the JSON property `metroCode` + # @return [String] + attr_accessor :metro_code + + # Name of this metro region. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @dma_id = args[:dma_id] if args.key?(:dma_id) + @kind = args[:kind] if args.key?(:kind) + @metro_code = args[:metro_code] if args.key?(:metro_code) + @name = args[:name] if args.key?(:name) + end + end + + # Metro List Response + class MetrosListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#metrosListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro collection. + # Corresponds to the JSON property `metros` + # @return [Array] + attr_accessor :metros + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @metros = args[:metros] if args.key?(:metros) + end + end + + # Contains information about a mobile carrier that can be targeted by ads. + class MobileCarrier + include Google::Apis::Core::Hashable + + # Country code of the country to which this mobile carrier belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this mobile carrier belongs. + # Corresponds to the JSON property `countryDartId` + # @return [String] + attr_accessor :country_dart_id + + # ID of this mobile carrier. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileCarrier". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this mobile carrier. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Mobile Carrier List Response + class MobileCarriersListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileCarriersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Mobile carrier collection. + # Corresponds to the JSON property `mobileCarriers` + # @return [Array] + attr_accessor :mobile_carriers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) + end + end + + # Object Filter. + class ObjectFilter + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#objectFilter". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Applicable when status is ASSIGNED. The user has access to objects with these + # object IDs. + # Corresponds to the JSON property `objectIds` + # @return [Array] + attr_accessor :object_ids + + # Status of the filter. NONE means the user has access to none of the objects. + # ALL means the user has access to all objects. ASSIGNED means the user has + # access to the objects with IDs in the objectIds list. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @object_ids = args[:object_ids] if args.key?(:object_ids) + @status = args[:status] if args.key?(:status) + end + end + + # Offset Position. + class OffsetPosition + include Google::Apis::Core::Hashable + + # Offset distance from left side of an asset or a window. + # Corresponds to the JSON property `left` + # @return [Fixnum] + attr_accessor :left + + # Offset distance from top side of an asset or a window. + # Corresponds to the JSON property `top` + # @return [Fixnum] + attr_accessor :top + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @left = args[:left] if args.key?(:left) + @top = args[:top] if args.key?(:top) + end + end + + # Omniture Integration Settings. + class OmnitureSettings + include Google::Apis::Core::Hashable + + # Whether placement cost data will be sent to Omniture. This property can be + # enabled only if omnitureIntegrationEnabled is true. + # Corresponds to the JSON property `omnitureCostDataEnabled` + # @return [Boolean] + attr_accessor :omniture_cost_data_enabled + alias_method :omniture_cost_data_enabled?, :omniture_cost_data_enabled + + # Whether Omniture integration is enabled. This property can be enabled only + # when the "Advanced Ad Serving" account setting is enabled. + # Corresponds to the JSON property `omnitureIntegrationEnabled` + # @return [Boolean] + attr_accessor :omniture_integration_enabled + alias_method :omniture_integration_enabled?, :omniture_integration_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @omniture_cost_data_enabled = args[:omniture_cost_data_enabled] if args.key?(:omniture_cost_data_enabled) + @omniture_integration_enabled = args[:omniture_integration_enabled] if args.key?(:omniture_integration_enabled) + end + end + + # Contains information about an operating system that can be targeted by ads. + class OperatingSystem + include Google::Apis::Core::Hashable + + # DART ID of this operating system. This is the ID used for targeting. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # Whether this operating system is for desktop. + # Corresponds to the JSON property `desktop` + # @return [Boolean] + attr_accessor :desktop + alias_method :desktop?, :desktop + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystem". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether this operating system is for mobile. + # Corresponds to the JSON property `mobile` + # @return [Boolean] + attr_accessor :mobile + alias_method :mobile?, :mobile + + # Name of this operating system. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @desktop = args[:desktop] if args.key?(:desktop) + @kind = args[:kind] if args.key?(:kind) + @mobile = args[:mobile] if args.key?(:mobile) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a particular version of an operating system that + # can be targeted by ads. + class OperatingSystemVersion + include Google::Apis::Core::Hashable + + # ID of this operating system version. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemVersion". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Major version (leftmost number) of this operating system version. + # Corresponds to the JSON property `majorVersion` + # @return [String] + attr_accessor :major_version + + # Minor version (number after the first dot) of this operating system version. + # Corresponds to the JSON property `minorVersion` + # @return [String] + attr_accessor :minor_version + + # Name of this operating system version. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Contains information about an operating system that can be targeted by ads. + # Corresponds to the JSON property `operatingSystem` + # @return [Google::Apis::DfareportingV2_7::OperatingSystem] + attr_accessor :operating_system + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @major_version = args[:major_version] if args.key?(:major_version) + @minor_version = args[:minor_version] if args.key?(:minor_version) + @name = args[:name] if args.key?(:name) + @operating_system = args[:operating_system] if args.key?(:operating_system) + end + end + + # Operating System Version List Response + class OperatingSystemVersionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemVersionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Operating system version collection. + # Corresponds to the JSON property `operatingSystemVersions` + # @return [Array] + attr_accessor :operating_system_versions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) + end + end + + # Operating System List Response + class OperatingSystemsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Operating system collection. + # Corresponds to the JSON property `operatingSystems` + # @return [Array] + attr_accessor :operating_systems + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @operating_systems = args[:operating_systems] if args.key?(:operating_systems) + end + end + + # Creative optimization activity. + class OptimizationActivity + include Google::Apis::Core::Hashable + + # Floodlight activity ID of this optimization activity. This is a required field. + # Corresponds to the JSON property `floodlightActivityId` + # @return [String] + attr_accessor :floodlight_activity_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightActivityIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_activity_id_dimension_value + + # Weight associated with this optimization. Must be greater than 1. The weight + # assigned will be understood in proportion to the weights assigned to the other + # optimization activities. + # Corresponds to the JSON property `weight` + # @return [Fixnum] + attr_accessor :weight + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_activity_id_dimension_value = args[:floodlight_activity_id_dimension_value] if args.key?(:floodlight_activity_id_dimension_value) + @weight = args[:weight] if args.key?(:weight) + end + end + + # Describes properties of a DoubleClick Planning order. + class Order + include Google::Apis::Core::Hashable + + # Account ID of this order. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this order. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # IDs for users that have to approve documents created for this order. + # Corresponds to the JSON property `approverUserProfileIds` + # @return [Array] + attr_accessor :approver_user_profile_ids + + # Buyer invoice ID associated with this order. + # Corresponds to the JSON property `buyerInvoiceId` + # @return [String] + attr_accessor :buyer_invoice_id + + # Name of the buyer organization. + # Corresponds to the JSON property `buyerOrganizationName` + # @return [String] + attr_accessor :buyer_organization_name + + # Comments in this order. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Contacts for this order. + # Corresponds to the JSON property `contacts` + # @return [Array] + attr_accessor :contacts + + # ID of this order. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#order". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this order. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Notes of this order. + # Corresponds to the JSON property `notes` + # @return [String] + attr_accessor :notes + + # ID of the terms and conditions template used in this order. + # Corresponds to the JSON property `planningTermId` + # @return [String] + attr_accessor :planning_term_id + + # Project ID of this order. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # Seller order ID associated with this order. + # Corresponds to the JSON property `sellerOrderId` + # @return [String] + attr_accessor :seller_order_id + + # Name of the seller organization. + # Corresponds to the JSON property `sellerOrganizationName` + # @return [String] + attr_accessor :seller_organization_name + + # Site IDs this order is associated with. + # Corresponds to the JSON property `siteId` + # @return [Array] + attr_accessor :site_id + + # Free-form site names this order is associated with. + # Corresponds to the JSON property `siteNames` + # @return [Array] + attr_accessor :site_names + + # Subaccount ID of this order. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Terms and conditions of this order. + # Corresponds to the JSON property `termsAndConditions` + # @return [String] + attr_accessor :terms_and_conditions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @approver_user_profile_ids = args[:approver_user_profile_ids] if args.key?(:approver_user_profile_ids) + @buyer_invoice_id = args[:buyer_invoice_id] if args.key?(:buyer_invoice_id) + @buyer_organization_name = args[:buyer_organization_name] if args.key?(:buyer_organization_name) + @comments = args[:comments] if args.key?(:comments) + @contacts = args[:contacts] if args.key?(:contacts) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @notes = args[:notes] if args.key?(:notes) + @planning_term_id = args[:planning_term_id] if args.key?(:planning_term_id) + @project_id = args[:project_id] if args.key?(:project_id) + @seller_order_id = args[:seller_order_id] if args.key?(:seller_order_id) + @seller_organization_name = args[:seller_organization_name] if args.key?(:seller_organization_name) + @site_id = args[:site_id] if args.key?(:site_id) + @site_names = args[:site_names] if args.key?(:site_names) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions) + end + end + + # Contact of an order. + class OrderContact + include Google::Apis::Core::Hashable + + # Free-form information about this contact. It could be any information related + # to this contact in addition to type, title, name, and signature user profile + # ID. + # Corresponds to the JSON property `contactInfo` + # @return [String] + attr_accessor :contact_info + + # Name of this contact. + # Corresponds to the JSON property `contactName` + # @return [String] + attr_accessor :contact_name + + # Title of this contact. + # Corresponds to the JSON property `contactTitle` + # @return [String] + attr_accessor :contact_title + + # Type of this contact. + # Corresponds to the JSON property `contactType` + # @return [String] + attr_accessor :contact_type + + # ID of the user profile containing the signature that will be embedded into + # order documents. + # Corresponds to the JSON property `signatureUserProfileId` + # @return [String] + attr_accessor :signature_user_profile_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contact_info = args[:contact_info] if args.key?(:contact_info) + @contact_name = args[:contact_name] if args.key?(:contact_name) + @contact_title = args[:contact_title] if args.key?(:contact_title) + @contact_type = args[:contact_type] if args.key?(:contact_type) + @signature_user_profile_id = args[:signature_user_profile_id] if args.key?(:signature_user_profile_id) + end + end + + # Contains properties of a DoubleClick Planning order document. + class OrderDocument + include Google::Apis::Core::Hashable + + # Account ID of this order document. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this order document. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # The amended order document ID of this order document. An order document can be + # created by optionally amending another order document so that the change + # history can be preserved. + # Corresponds to the JSON property `amendedOrderDocumentId` + # @return [String] + attr_accessor :amended_order_document_id + + # IDs of users who have approved this order document. + # Corresponds to the JSON property `approvedByUserProfileIds` + # @return [Array] + attr_accessor :approved_by_user_profile_ids + + # Whether this order document is cancelled. + # Corresponds to the JSON property `cancelled` + # @return [Boolean] + attr_accessor :cancelled + alias_method :cancelled?, :cancelled + + # Modification timestamp. + # Corresponds to the JSON property `createdInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :created_info + + # Effective date of this order document. + # Corresponds to the JSON property `effectiveDate` + # @return [Date] + attr_accessor :effective_date + + # ID of this order document. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#orderDocument". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # List of email addresses that received the last sent document. + # Corresponds to the JSON property `lastSentRecipients` + # @return [Array] + attr_accessor :last_sent_recipients + + # Timestamp of the last email sent with this order document. + # Corresponds to the JSON property `lastSentTime` + # @return [DateTime] + attr_accessor :last_sent_time + + # ID of the order from which this order document is created. + # Corresponds to the JSON property `orderId` + # @return [String] + attr_accessor :order_id + + # Project ID of this order document. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # Whether this order document has been signed. + # Corresponds to the JSON property `signed` + # @return [Boolean] + attr_accessor :signed + alias_method :signed?, :signed + + # Subaccount ID of this order document. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Title of this order document. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Type of this order document + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @amended_order_document_id = args[:amended_order_document_id] if args.key?(:amended_order_document_id) + @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] if args.key?(:approved_by_user_profile_ids) + @cancelled = args[:cancelled] if args.key?(:cancelled) + @created_info = args[:created_info] if args.key?(:created_info) + @effective_date = args[:effective_date] if args.key?(:effective_date) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_sent_recipients = args[:last_sent_recipients] if args.key?(:last_sent_recipients) + @last_sent_time = args[:last_sent_time] if args.key?(:last_sent_time) + @order_id = args[:order_id] if args.key?(:order_id) + @project_id = args[:project_id] if args.key?(:project_id) + @signed = args[:signed] if args.key?(:signed) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @title = args[:title] if args.key?(:title) + @type = args[:type] if args.key?(:type) + end + end + + # Order document List Response + class OrderDocumentsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#orderDocumentsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Order document collection + # Corresponds to the JSON property `orderDocuments` + # @return [Array] + attr_accessor :order_documents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @order_documents = args[:order_documents] if args.key?(:order_documents) + end + end + + # Order List Response + class OrdersListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#ordersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Order collection. + # Corresponds to the JSON property `orders` + # @return [Array] + attr_accessor :orders + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @orders = args[:orders] if args.key?(:orders) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # PATH_TO_CONVERSION". + class PathToConversionReportCompatibleFields + include Google::Apis::Core::Hashable + + # Conversion dimensions which are compatible to be selected in the " + # conversionDimensions" section of the report. + # Corresponds to the JSON property `conversionDimensions` + # @return [Array] + attr_accessor :conversion_dimensions + + # Custom floodlight variables which are compatible to be selected in the " + # customFloodlightVariables" section of the report. + # Corresponds to the JSON property `customFloodlightVariables` + # @return [Array] + attr_accessor :custom_floodlight_variables + + # The kind of resource this is, in this case dfareporting# + # pathToConversionReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Per-interaction dimensions which are compatible to be selected in the " + # perInteractionDimensions" section of the report. + # Corresponds to the JSON property `perInteractionDimensions` + # @return [Array] + attr_accessor :per_interaction_dimensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) + @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) + end + end + + # Contains properties of a placement. + class Placement + include Google::Apis::Core::Hashable + + # Account ID of this placement. This field can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this placement. This field can be left blank. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this placement is archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Campaign ID of this placement. This field is a required field on insertion. + # Corresponds to the JSON property `campaignId` + # @return [String] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Comments for this placement. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # on desktop, on mobile devices or in mobile apps for regular or interstitial + # ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new + # placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. + # IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the + # VAST standard. This field is required on insertion. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # ID of the content category assigned to this placement. + # Corresponds to the JSON property `contentCategoryId` + # @return [String] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :create_info + + # Directory site ID of this placement. On insert, you must set either this field + # or the siteId field to specify the site associated with this placement. This + # is a required field that is read-only after insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [String] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # External ID for this placement. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this placement. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Key name of this placement. This is a read-only, auto-generated field. + # Corresponds to the JSON property `keyName` + # @return [String] + attr_accessor :key_name + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placement". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV2_7::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Name of this placement.This is a required field and must be less than 256 + # characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether payment was approved for this placement. This is a read-only field + # relevant only to publisher-paid placements. + # Corresponds to the JSON property `paymentApproved` + # @return [Boolean] + attr_accessor :payment_approved + alias_method :payment_approved?, :payment_approved + + # Payment source for this placement. This is a required field that is read-only + # after insertion. + # Corresponds to the JSON property `paymentSource` + # @return [String] + attr_accessor :payment_source + + # ID of this placement's group, if applicable. + # Corresponds to the JSON property `placementGroupId` + # @return [String] + attr_accessor :placement_group_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementGroupIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :placement_group_id_dimension_value + + # ID of the placement strategy assigned to this placement. + # Corresponds to the JSON property `placementStrategyId` + # @return [String] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV2_7::PricingSchedule] + attr_accessor :pricing_schedule + + # Whether this placement is the primary placement of a roadblock (placement + # group). You cannot change this field from true to false. Setting this field to + # true will automatically set the primary field on the original primary + # placement of the roadblock to false, and it will automatically set the + # roadblock's primaryPlacementId field to the ID of this placement. + # Corresponds to the JSON property `primary` + # @return [Boolean] + attr_accessor :primary + alias_method :primary?, :primary + + # Modification timestamp. + # Corresponds to the JSON property `publisherUpdateInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :publisher_update_info + + # Site ID associated with this placement. On insert, you must set either this + # field or the directorySiteId field to specify the site associated with this + # placement. This is a required field that is read-only after insertion. + # Corresponds to the JSON property `siteId` + # @return [String] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :site_id_dimension_value + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :size + + # Whether creatives assigned to this placement must be SSL-compliant. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Third-party placement status. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this placement. This field can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Tag formats to generate for this placement. This field is required on + # insertion. + # Acceptable values are: + # - "PLACEMENT_TAG_STANDARD" + # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" + # - "PLACEMENT_TAG_IFRAME_ILAYER" + # - "PLACEMENT_TAG_INTERNAL_REDIRECT" + # - "PLACEMENT_TAG_JAVASCRIPT" + # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" + # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" + # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" + # - "PLACEMENT_TAG_CLICK_COMMANDS" + # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" + # - "PLACEMENT_TAG_TRACKING" + # - "PLACEMENT_TAG_TRACKING_IFRAME" + # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + # Corresponds to the JSON property `tagFormats` + # @return [Array] + attr_accessor :tag_formats + + # Tag Settings + # Corresponds to the JSON property `tagSetting` + # @return [Google::Apis::DfareportingV2_7::TagSetting] + attr_accessor :tag_setting + + # Whether Verification and ActiveView are disabled for in-stream video creatives + # for this placement. The same setting videoActiveViewOptOut exists on the site + # level -- the opt out occurs if either of these settings are true. These + # settings are distinct from DirectorySites.settings.activeViewOptOut or Sites. + # siteSettings.activeViewOptOut which only apply to display ads. However, + # Accounts.activeViewOptOut opts out both video traffic, as well as display ads, + # from Verification and ActiveView. + # Corresponds to the JSON property `videoActiveViewOptOut` + # @return [Boolean] + attr_accessor :video_active_view_opt_out + alias_method :video_active_view_opt_out?, :video_active_view_opt_out + + # Video Settings + # Corresponds to the JSON property `videoSettings` + # @return [Google::Apis::DfareportingV2_7::VideoSettings] + attr_accessor :video_settings + + # VPAID adapter setting for this placement. Controls which VPAID format the + # measurement adapter will use for in-stream video creatives assigned to this + # placement. + # Corresponds to the JSON property `vpaidAdapterChoice` + # @return [String] + attr_accessor :vpaid_adapter_choice + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @comment = args[:comment] if args.key?(:comment) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @create_info = args[:create_info] if args.key?(:create_info) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_name = args[:key_name] if args.key?(:key_name) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @name = args[:name] if args.key?(:name) + @payment_approved = args[:payment_approved] if args.key?(:payment_approved) + @payment_source = args[:payment_source] if args.key?(:payment_source) + @placement_group_id = args[:placement_group_id] if args.key?(:placement_group_id) + @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] if args.key?(:placement_group_id_dimension_value) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) + @primary = args[:primary] if args.key?(:primary) + @publisher_update_info = args[:publisher_update_info] if args.key?(:publisher_update_info) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @size = args[:size] if args.key?(:size) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_formats = args[:tag_formats] if args.key?(:tag_formats) + @tag_setting = args[:tag_setting] if args.key?(:tag_setting) + @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) + @video_settings = args[:video_settings] if args.key?(:video_settings) + @vpaid_adapter_choice = args[:vpaid_adapter_choice] if args.key?(:vpaid_adapter_choice) + end + end + + # Placement Assignment. + class PlacementAssignment + include Google::Apis::Core::Hashable + + # Whether this placement assignment is active. When true, the placement will be + # included in the ad's rotation. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # ID of the placement to be assigned. This is a required field. + # Corresponds to the JSON property `placementId` + # @return [String] + attr_accessor :placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :placement_id_dimension_value + + # Whether the placement to be assigned requires SSL. This is a read-only field + # that is auto-generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @placement_id = args[:placement_id] if args.key?(:placement_id) + @placement_id_dimension_value = args[:placement_id_dimension_value] if args.key?(:placement_id_dimension_value) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + end + end + + # Contains properties of a package or roadblock. + class PlacementGroup + include Google::Apis::Core::Hashable + + # Account ID of this placement group. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this placement group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this placement group is archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Campaign ID of this placement group. This field is required on insertion. + # Corresponds to the JSON property `campaignId` + # @return [String] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # IDs of placements which are assigned to this placement group. This is a read- + # only, auto-generated field. + # Corresponds to the JSON property `childPlacementIds` + # @return [Array] + attr_accessor :child_placement_ids + + # Comments for this placement group. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # ID of the content category assigned to this placement group. + # Corresponds to the JSON property `contentCategoryId` + # @return [String] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :create_info + + # Directory site ID associated with this placement group. On insert, you must + # set either this field or the site_id field to specify the site associated with + # this placement group. This is a required field that is read-only after + # insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [String] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # External ID for this placement. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this placement group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this placement group. This is a required field and must be less than + # 256 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Type of this placement group. A package is a simple group of placements that + # acts as a single pricing point for a group of tags. A roadblock is a group of + # placements that not only acts as a single pricing point, but also assumes that + # all the tags in it will be served at the same time. A roadblock requires one + # of its assigned placements to be marked as primary for reporting. This field + # is required on insertion. + # Corresponds to the JSON property `placementGroupType` + # @return [String] + attr_accessor :placement_group_type + + # ID of the placement strategy assigned to this placement group. + # Corresponds to the JSON property `placementStrategyId` + # @return [String] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV2_7::PricingSchedule] + attr_accessor :pricing_schedule + + # ID of the primary placement, used to calculate the media cost of a roadblock ( + # placement group). Modifying this field will automatically modify the primary + # field on all affected roadblock child placements. + # Corresponds to the JSON property `primaryPlacementId` + # @return [String] + attr_accessor :primary_placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `primaryPlacementIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :primary_placement_id_dimension_value + + # Site ID associated with this placement group. On insert, you must set either + # this field or the directorySiteId field to specify the site associated with + # this placement group. This is a required field that is read-only after + # insertion. + # Corresponds to the JSON property `siteId` + # @return [String] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :site_id_dimension_value + + # Subaccount ID of this placement group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @child_placement_ids = args[:child_placement_ids] if args.key?(:child_placement_ids) + @comment = args[:comment] if args.key?(:comment) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @create_info = args[:create_info] if args.key?(:create_info) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @placement_group_type = args[:placement_group_type] if args.key?(:placement_group_type) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) + @primary_placement_id = args[:primary_placement_id] if args.key?(:primary_placement_id) + @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] if args.key?(:primary_placement_id_dimension_value) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Placement Group List Response + class PlacementGroupsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement group collection. + # Corresponds to the JSON property `placementGroups` + # @return [Array] + attr_accessor :placement_groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placement_groups = args[:placement_groups] if args.key?(:placement_groups) + end + end + + # Placement Strategy List Response + class PlacementStrategiesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementStrategiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement strategy collection. + # Corresponds to the JSON property `placementStrategies` + # @return [Array] + attr_accessor :placement_strategies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placement_strategies = args[:placement_strategies] if args.key?(:placement_strategies) + end + end + + # Contains properties of a placement strategy. + class PlacementStrategy + include Google::Apis::Core::Hashable + + # Account ID of this placement strategy.This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # ID of this placement strategy. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementStrategy". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this placement strategy. This is a required field. It must be less + # than 256 characters long and unique among placement strategies of the same + # account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Placement Tag + class PlacementTag + include Google::Apis::Core::Hashable + + # Placement ID + # Corresponds to the JSON property `placementId` + # @return [String] + attr_accessor :placement_id + + # Tags generated for this placement. + # Corresponds to the JSON property `tagDatas` + # @return [Array] + attr_accessor :tag_datas + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @placement_id = args[:placement_id] if args.key?(:placement_id) + @tag_datas = args[:tag_datas] if args.key?(:tag_datas) + end + end + + # Placement GenerateTags Response + class PlacementsGenerateTagsResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementsGenerateTagsResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Set of generated tags for the specified placements. + # Corresponds to the JSON property `placementTags` + # @return [Array] + attr_accessor :placement_tags + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @placement_tags = args[:placement_tags] if args.key?(:placement_tags) + end + end + + # Placement List Response + class PlacementsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement collection. + # Corresponds to the JSON property `placements` + # @return [Array] + attr_accessor :placements + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placements = args[:placements] if args.key?(:placements) + end + end + + # Contains information about a platform type that can be targeted by ads. + class PlatformType + include Google::Apis::Core::Hashable + + # ID of this platform type. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#platformType". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this platform type. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Platform Type List Response + class PlatformTypesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#platformTypesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Platform type collection. + # Corresponds to the JSON property `platformTypes` + # @return [Array] + attr_accessor :platform_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @platform_types = args[:platform_types] if args.key?(:platform_types) + end + end + + # Popup Window Properties. + class PopupWindowProperties + include Google::Apis::Core::Hashable + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `dimension` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :dimension + + # Offset Position. + # Corresponds to the JSON property `offset` + # @return [Google::Apis::DfareportingV2_7::OffsetPosition] + attr_accessor :offset + + # Popup window position either centered or at specific coordinate. + # Corresponds to the JSON property `positionType` + # @return [String] + attr_accessor :position_type + + # Whether to display the browser address bar. + # Corresponds to the JSON property `showAddressBar` + # @return [Boolean] + attr_accessor :show_address_bar + alias_method :show_address_bar?, :show_address_bar + + # Whether to display the browser menu bar. + # Corresponds to the JSON property `showMenuBar` + # @return [Boolean] + attr_accessor :show_menu_bar + alias_method :show_menu_bar?, :show_menu_bar + + # Whether to display the browser scroll bar. + # Corresponds to the JSON property `showScrollBar` + # @return [Boolean] + attr_accessor :show_scroll_bar + alias_method :show_scroll_bar?, :show_scroll_bar + + # Whether to display the browser status bar. + # Corresponds to the JSON property `showStatusBar` + # @return [Boolean] + attr_accessor :show_status_bar + alias_method :show_status_bar?, :show_status_bar + + # Whether to display the browser tool bar. + # Corresponds to the JSON property `showToolBar` + # @return [Boolean] + attr_accessor :show_tool_bar + alias_method :show_tool_bar?, :show_tool_bar + + # Title of popup window. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension = args[:dimension] if args.key?(:dimension) + @offset = args[:offset] if args.key?(:offset) + @position_type = args[:position_type] if args.key?(:position_type) + @show_address_bar = args[:show_address_bar] if args.key?(:show_address_bar) + @show_menu_bar = args[:show_menu_bar] if args.key?(:show_menu_bar) + @show_scroll_bar = args[:show_scroll_bar] if args.key?(:show_scroll_bar) + @show_status_bar = args[:show_status_bar] if args.key?(:show_status_bar) + @show_tool_bar = args[:show_tool_bar] if args.key?(:show_tool_bar) + @title = args[:title] if args.key?(:title) + end + end + + # Contains information about a postal code that can be targeted by ads. + class PostalCode + include Google::Apis::Core::Hashable + + # Postal code. This is equivalent to the id field. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Country code of the country to which this postal code belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this postal code belongs. + # Corresponds to the JSON property `countryDartId` + # @return [String] + attr_accessor :country_dart_id + + # ID of this postal code. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#postalCode". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Postal Code List Response + class PostalCodesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#postalCodesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Postal code collection. + # Corresponds to the JSON property `postalCodes` + # @return [Array] + attr_accessor :postal_codes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @postal_codes = args[:postal_codes] if args.key?(:postal_codes) + end + end + + # Pricing Information + class Pricing + include Google::Apis::Core::Hashable + + # Cap cost type of this inventory item. + # Corresponds to the JSON property `capCostType` + # @return [String] + attr_accessor :cap_cost_type + + # End date of this inventory item. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Flights of this inventory item. A flight (a.k.a. pricing period) represents + # the inventory item pricing information for a specific period of time. + # Corresponds to the JSON property `flights` + # @return [Array] + attr_accessor :flights + + # Group type of this inventory item if it represents a placement group. Is null + # otherwise. There are two type of placement groups: + # PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items + # that acts as a single pricing point for a group of tags. + # PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not + # only acts as a single pricing point, but also assumes that all the tags in it + # will be served at the same time. A roadblock requires one of its assigned + # inventory items to be marked as primary. + # Corresponds to the JSON property `groupType` + # @return [String] + attr_accessor :group_type + + # Pricing type of this inventory item. + # Corresponds to the JSON property `pricingType` + # @return [String] + attr_accessor :pricing_type + + # Start date of this inventory item. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cap_cost_type = args[:cap_cost_type] if args.key?(:cap_cost_type) + @end_date = args[:end_date] if args.key?(:end_date) + @flights = args[:flights] if args.key?(:flights) + @group_type = args[:group_type] if args.key?(:group_type) + @pricing_type = args[:pricing_type] if args.key?(:pricing_type) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Pricing Schedule + class PricingSchedule + include Google::Apis::Core::Hashable + + # Placement cap cost option. + # Corresponds to the JSON property `capCostOption` + # @return [String] + attr_accessor :cap_cost_option + + # Whether cap costs are ignored by ad serving. + # Corresponds to the JSON property `disregardOverdelivery` + # @return [Boolean] + attr_accessor :disregard_overdelivery + alias_method :disregard_overdelivery?, :disregard_overdelivery + + # Placement end date. This date must be later than, or the same day as, the + # placement start date, but not later than the campaign end date. If, for + # example, you set 6/25/2015 as both the start and end dates, the effective + # placement date is just that day only, 6/25/2015. The hours, minutes, and + # seconds of the end date should not be set, as doing so will result in an error. + # This field is required on insertion. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Whether this placement is flighted. If true, pricing periods will be computed + # automatically. + # Corresponds to the JSON property `flighted` + # @return [Boolean] + attr_accessor :flighted + alias_method :flighted?, :flighted + + # Floodlight activity ID associated with this placement. This field should be + # set when placement pricing type is set to PRICING_TYPE_CPA. + # Corresponds to the JSON property `floodlightActivityId` + # @return [String] + attr_accessor :floodlight_activity_id + + # Pricing periods for this placement. + # Corresponds to the JSON property `pricingPeriods` + # @return [Array] + attr_accessor :pricing_periods + + # Placement pricing type. This field is required on insertion. + # Corresponds to the JSON property `pricingType` + # @return [String] + attr_accessor :pricing_type + + # Placement start date. This date must be later than, or the same day as, the + # campaign start date. The hours, minutes, and seconds of the start date should + # not be set, as doing so will result in an error. This field is required on + # insertion. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Testing start date of this placement. The hours, minutes, and seconds of the + # start date should not be set, as doing so will result in an error. + # Corresponds to the JSON property `testingStartDate` + # @return [Date] + attr_accessor :testing_start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cap_cost_option = args[:cap_cost_option] if args.key?(:cap_cost_option) + @disregard_overdelivery = args[:disregard_overdelivery] if args.key?(:disregard_overdelivery) + @end_date = args[:end_date] if args.key?(:end_date) + @flighted = args[:flighted] if args.key?(:flighted) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @pricing_periods = args[:pricing_periods] if args.key?(:pricing_periods) + @pricing_type = args[:pricing_type] if args.key?(:pricing_type) + @start_date = args[:start_date] if args.key?(:start_date) + @testing_start_date = args[:testing_start_date] if args.key?(:testing_start_date) + end + end + + # Pricing Period + class PricingSchedulePricingPeriod + include Google::Apis::Core::Hashable + + # Pricing period end date. This date must be later than, or the same day as, the + # pricing period start date, but not later than the placement end date. The + # period end date can be the same date as the period start date. If, for example, + # you set 6/25/2015 as both the start and end dates, the effective pricing + # period date is just that day only, 6/25/2015. The hours, minutes, and seconds + # of the end date should not be set, as doing so will result in an error. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Comments for this pricing period. + # Corresponds to the JSON property `pricingComment` + # @return [String] + attr_accessor :pricing_comment + + # Rate or cost of this pricing period. + # Corresponds to the JSON property `rateOrCostNanos` + # @return [String] + attr_accessor :rate_or_cost_nanos + + # Pricing period start date. This date must be later than, or the same day as, + # the placement start date. The hours, minutes, and seconds of the start date + # should not be set, as doing so will result in an error. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Units of this pricing period. + # Corresponds to the JSON property `units` + # @return [String] + attr_accessor :units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @pricing_comment = args[:pricing_comment] if args.key?(:pricing_comment) + @rate_or_cost_nanos = args[:rate_or_cost_nanos] if args.key?(:rate_or_cost_nanos) + @start_date = args[:start_date] if args.key?(:start_date) + @units = args[:units] if args.key?(:units) + end + end + + # Contains properties of a DoubleClick Planning project. + class Project + include Google::Apis::Core::Hashable + + # Account ID of this project. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this project. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Audience age group of this project. + # Corresponds to the JSON property `audienceAgeGroup` + # @return [String] + attr_accessor :audience_age_group + + # Audience gender of this project. + # Corresponds to the JSON property `audienceGender` + # @return [String] + attr_accessor :audience_gender + + # Budget of this project in the currency specified by the current account. The + # value stored in this field represents only the non-fractional amount. For + # example, for USD, the smallest value that can be represented by this field is + # 1 US dollar. + # Corresponds to the JSON property `budget` + # @return [String] + attr_accessor :budget + + # Client billing code of this project. + # Corresponds to the JSON property `clientBillingCode` + # @return [String] + attr_accessor :client_billing_code + + # Name of the project client. + # Corresponds to the JSON property `clientName` + # @return [String] + attr_accessor :client_name + + # End date of the project. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # ID of this project. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#project". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV2_7::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this project. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Overview of this project. + # Corresponds to the JSON property `overview` + # @return [String] + attr_accessor :overview + + # Start date of the project. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Subaccount ID of this project. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Number of clicks that the advertiser is targeting. + # Corresponds to the JSON property `targetClicks` + # @return [String] + attr_accessor :target_clicks + + # Number of conversions that the advertiser is targeting. + # Corresponds to the JSON property `targetConversions` + # @return [String] + attr_accessor :target_conversions + + # CPA that the advertiser is targeting. + # Corresponds to the JSON property `targetCpaNanos` + # @return [String] + attr_accessor :target_cpa_nanos + + # CPC that the advertiser is targeting. + # Corresponds to the JSON property `targetCpcNanos` + # @return [String] + attr_accessor :target_cpc_nanos + + # vCPM from Active View that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmActiveViewNanos` + # @return [String] + attr_accessor :target_cpm_active_view_nanos + + # CPM that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmNanos` + # @return [String] + attr_accessor :target_cpm_nanos + + # Number of impressions that the advertiser is targeting. + # Corresponds to the JSON property `targetImpressions` + # @return [String] + attr_accessor :target_impressions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @audience_age_group = args[:audience_age_group] if args.key?(:audience_age_group) + @audience_gender = args[:audience_gender] if args.key?(:audience_gender) + @budget = args[:budget] if args.key?(:budget) + @client_billing_code = args[:client_billing_code] if args.key?(:client_billing_code) + @client_name = args[:client_name] if args.key?(:client_name) + @end_date = args[:end_date] if args.key?(:end_date) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @overview = args[:overview] if args.key?(:overview) + @start_date = args[:start_date] if args.key?(:start_date) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @target_clicks = args[:target_clicks] if args.key?(:target_clicks) + @target_conversions = args[:target_conversions] if args.key?(:target_conversions) + @target_cpa_nanos = args[:target_cpa_nanos] if args.key?(:target_cpa_nanos) + @target_cpc_nanos = args[:target_cpc_nanos] if args.key?(:target_cpc_nanos) + @target_cpm_active_view_nanos = args[:target_cpm_active_view_nanos] if args.key?(:target_cpm_active_view_nanos) + @target_cpm_nanos = args[:target_cpm_nanos] if args.key?(:target_cpm_nanos) + @target_impressions = args[:target_impressions] if args.key?(:target_impressions) + end + end + + # Project List Response + class ProjectsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#projectsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Project collection. + # Corresponds to the JSON property `projects` + # @return [Array] + attr_accessor :projects + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @projects = args[:projects] if args.key?(:projects) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # REACH". + class ReachReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting# + # reachReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected as activity metrics to pivot on in + # the "activities" section of the report. + # Corresponds to the JSON property `pivotedActivityMetrics` + # @return [Array] + attr_accessor :pivoted_activity_metrics + + # Metrics which are compatible to be selected in the " + # reachByFrequencyMetricNames" section of the report. + # Corresponds to the JSON property `reachByFrequencyMetrics` + # @return [Array] + attr_accessor :reach_by_frequency_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) + @reach_by_frequency_metrics = args[:reach_by_frequency_metrics] if args.key?(:reach_by_frequency_metrics) + end + end + + # Represents a recipient. + class Recipient + include Google::Apis::Core::Hashable + + # The delivery type for the recipient. + # Corresponds to the JSON property `deliveryType` + # @return [String] + attr_accessor :delivery_type + + # The email address of the recipient. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # The kind of resource this is, in this case dfareporting#recipient. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @delivery_type = args[:delivery_type] if args.key?(:delivery_type) + @email = args[:email] if args.key?(:email) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a region that can be targeted by ads. + class Region + include Google::Apis::Core::Hashable + + # Country code of the country to which this region belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this region belongs. + # Corresponds to the JSON property `countryDartId` + # @return [String] + attr_accessor :country_dart_id + + # DART ID of this region. + # Corresponds to the JSON property `dartId` + # @return [String] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#region". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this region. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Region code. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @region_code = args[:region_code] if args.key?(:region_code) + end + end + + # Region List Response + class RegionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#regionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Region collection. + # Corresponds to the JSON property `regions` + # @return [Array] + attr_accessor :regions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @regions = args[:regions] if args.key?(:regions) + end + end + + # Contains properties of a remarketing list. Remarketing enables you to create + # lists of users who have performed specific actions on a site, then target ads + # to members of those lists. This resource can be used to manage remarketing + # lists that are owned by your advertisers. To see all remarketing lists that + # are visible to your advertisers, including those that are shared to your + # advertiser or account, use the TargetableRemarketingLists resource. + class RemarketingList + include Google::Apis::Core::Hashable + + # Account ID of this remarketing list. This is a read-only, auto-generated field + # that is only returned in GET requests. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this remarketing list is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Dimension value for the advertiser ID that owns this remarketing list. This is + # a required field. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Remarketing list description. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Remarketing list ID. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingList". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Number of days that a user should remain in the remarketing list without an + # impression. + # Corresponds to the JSON property `lifeSpan` + # @return [String] + attr_accessor :life_span + + # Remarketing List Population Rule. + # Corresponds to the JSON property `listPopulationRule` + # @return [Google::Apis::DfareportingV2_7::ListPopulationRule] + attr_accessor :list_population_rule + + # Number of users currently in the list. This is a read-only field. + # Corresponds to the JSON property `listSize` + # @return [String] + attr_accessor :list_size + + # Product from which this remarketing list was originated. + # Corresponds to the JSON property `listSource` + # @return [String] + attr_accessor :list_source + + # Name of the remarketing list. This is a required field. Must be no greater + # than 128 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this remarketing list. This is a read-only, auto-generated + # field that is only returned in GET requests. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @life_span = args[:life_span] if args.key?(:life_span) + @list_population_rule = args[:list_population_rule] if args.key?(:list_population_rule) + @list_size = args[:list_size] if args.key?(:list_size) + @list_source = args[:list_source] if args.key?(:list_source) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Contains properties of a remarketing list's sharing information. Sharing + # allows other accounts or advertisers to target to your remarketing lists. This + # resource can be used to manage remarketing list sharing to other accounts and + # advertisers. + class RemarketingListShare + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingListShare". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Remarketing list ID. This is a read-only, auto-generated field. + # Corresponds to the JSON property `remarketingListId` + # @return [String] + attr_accessor :remarketing_list_id + + # Accounts that the remarketing list is shared with. + # Corresponds to the JSON property `sharedAccountIds` + # @return [Array] + attr_accessor :shared_account_ids + + # Advertisers that the remarketing list is shared with. + # Corresponds to the JSON property `sharedAdvertiserIds` + # @return [Array] + attr_accessor :shared_advertiser_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) + @shared_account_ids = args[:shared_account_ids] if args.key?(:shared_account_ids) + @shared_advertiser_ids = args[:shared_advertiser_ids] if args.key?(:shared_advertiser_ids) + end + end + + # Remarketing list response + class RemarketingListsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingListsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Remarketing list collection. + # Corresponds to the JSON property `remarketingLists` + # @return [Array] + attr_accessor :remarketing_lists + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @remarketing_lists = args[:remarketing_lists] if args.key?(:remarketing_lists) + end + end + + # Represents a Report resource. + class Report + include Google::Apis::Core::Hashable + + # The account ID to which this report belongs. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # The report criteria for a report of type "STANDARD". + # Corresponds to the JSON property `criteria` + # @return [Google::Apis::DfareportingV2_7::Report::Criteria] + attr_accessor :criteria + + # The report criteria for a report of type "CROSS_DIMENSION_REACH". + # Corresponds to the JSON property `crossDimensionReachCriteria` + # @return [Google::Apis::DfareportingV2_7::Report::CrossDimensionReachCriteria] + attr_accessor :cross_dimension_reach_criteria + + # The report's email delivery settings. + # Corresponds to the JSON property `delivery` + # @return [Google::Apis::DfareportingV2_7::Report::Delivery] + attr_accessor :delivery + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The filename used when generating report files for this report. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + # The report criteria for a report of type "FLOODLIGHT". + # Corresponds to the JSON property `floodlightCriteria` + # @return [Google::Apis::DfareportingV2_7::Report::FloodlightCriteria] + attr_accessor :floodlight_criteria + + # The output format of the report. If not specified, default format is "CSV". + # Note that the actual format in the completed report file might differ if for + # instance the report's size exceeds the format's capabilities. "CSV" will then + # be the fallback format. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # The unique ID identifying this report resource. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#report. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The timestamp (in milliseconds since epoch) of when this report was last + # modified. + # Corresponds to the JSON property `lastModifiedTime` + # @return [String] + attr_accessor :last_modified_time + + # The name of the report. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The user profile id of the owner of this report. + # Corresponds to the JSON property `ownerProfileId` + # @return [String] + attr_accessor :owner_profile_id + + # The report criteria for a report of type "PATH_TO_CONVERSION". + # Corresponds to the JSON property `pathToConversionCriteria` + # @return [Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria] + attr_accessor :path_to_conversion_criteria + + # The report criteria for a report of type "REACH". + # Corresponds to the JSON property `reachCriteria` + # @return [Google::Apis::DfareportingV2_7::Report::ReachCriteria] + attr_accessor :reach_criteria + + # The report's schedule. Can only be set if the report's 'dateRange' is a + # relative date range and the relative date range is not "TODAY". + # Corresponds to the JSON property `schedule` + # @return [Google::Apis::DfareportingV2_7::Report::Schedule] + attr_accessor :schedule + + # The subaccount ID to which this report belongs if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [String] + attr_accessor :sub_account_id + + # The type of the report. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @criteria = args[:criteria] if args.key?(:criteria) + @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] if args.key?(:cross_dimension_reach_criteria) + @delivery = args[:delivery] if args.key?(:delivery) + @etag = args[:etag] if args.key?(:etag) + @file_name = args[:file_name] if args.key?(:file_name) + @floodlight_criteria = args[:floodlight_criteria] if args.key?(:floodlight_criteria) + @format = args[:format] if args.key?(:format) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) + @name = args[:name] if args.key?(:name) + @owner_profile_id = args[:owner_profile_id] if args.key?(:owner_profile_id) + @path_to_conversion_criteria = args[:path_to_conversion_criteria] if args.key?(:path_to_conversion_criteria) + @reach_criteria = args[:reach_criteria] if args.key?(:reach_criteria) + @schedule = args[:schedule] if args.key?(:schedule) + @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) + @type = args[:type] if args.key?(:type) + end + + # The report criteria for a report of type "STANDARD". + class Criteria + include Google::Apis::Core::Hashable + + # Represents an activity group. + # Corresponds to the JSON property `activities` + # @return [Google::Apis::DfareportingV2_7::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV2_7::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of standard dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activities = args[:activities] if args.key?(:activities) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @metric_names = args[:metric_names] if args.key?(:metric_names) + end + end + + # The report criteria for a report of type "CROSS_DIMENSION_REACH". + class CrossDimensionReachCriteria + include Google::Apis::Core::Hashable + + # The list of dimensions the report should include. + # Corresponds to the JSON property `breakdown` + # @return [Array] + attr_accessor :breakdown + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # The dimension option. + # Corresponds to the JSON property `dimension` + # @return [String] + attr_accessor :dimension + + # The list of filters on which dimensions are filtered. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of names of overlap metrics the report should include. + # Corresponds to the JSON property `overlapMetricNames` + # @return [Array] + attr_accessor :overlap_metric_names + + # Whether the report is pivoted or not. Defaults to true. + # Corresponds to the JSON property `pivoted` + # @return [Boolean] + attr_accessor :pivoted + alias_method :pivoted?, :pivoted + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @breakdown = args[:breakdown] if args.key?(:breakdown) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension = args[:dimension] if args.key?(:dimension) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @overlap_metric_names = args[:overlap_metric_names] if args.key?(:overlap_metric_names) + @pivoted = args[:pivoted] if args.key?(:pivoted) + end + end + + # The report's email delivery settings. + class Delivery + include Google::Apis::Core::Hashable + + # Whether the report should be emailed to the report owner. + # Corresponds to the JSON property `emailOwner` + # @return [Boolean] + attr_accessor :email_owner + alias_method :email_owner?, :email_owner + + # The type of delivery for the owner to receive, if enabled. + # Corresponds to the JSON property `emailOwnerDeliveryType` + # @return [String] + attr_accessor :email_owner_delivery_type + + # The message to be sent with each email. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + # The list of recipients to which to email the report. + # Corresponds to the JSON property `recipients` + # @return [Array] + attr_accessor :recipients + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email_owner = args[:email_owner] if args.key?(:email_owner) + @email_owner_delivery_type = args[:email_owner_delivery_type] if args.key?(:email_owner_delivery_type) + @message = args[:message] if args.key?(:message) + @recipients = args[:recipients] if args.key?(:recipients) + end + end + + # The report criteria for a report of type "FLOODLIGHT". + class FloodlightCriteria + include Google::Apis::Core::Hashable + + # The list of custom rich media events to include. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Array] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigId` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_config_id + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The properties of the report. + # Corresponds to the JSON property `reportProperties` + # @return [Google::Apis::DfareportingV2_7::Report::FloodlightCriteria::ReportProperties] + attr_accessor :report_properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @report_properties = args[:report_properties] if args.key?(:report_properties) + end + + # The properties of the report. + class ReportProperties + include Google::Apis::Core::Hashable + + # Include conversions that have no cookie, but do have an exposure path. + # Corresponds to the JSON property `includeAttributedIPConversions` + # @return [Boolean] + attr_accessor :include_attributed_ip_conversions + alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions + + # Include conversions of users with a DoubleClick cookie but without an exposure. + # That means the user did not click or see an ad from the advertiser within the + # Floodlight group, or that the interaction happened outside the lookback window. + # Corresponds to the JSON property `includeUnattributedCookieConversions` + # @return [Boolean] + attr_accessor :include_unattributed_cookie_conversions + alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions + + # Include conversions that have no associated cookies and no exposures. It’s + # therefore impossible to know how the user was exposed to your ads during the + # lookback window prior to a conversion. + # Corresponds to the JSON property `includeUnattributedIPConversions` + # @return [Boolean] + attr_accessor :include_unattributed_ip_conversions + alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) + @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) + @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) + end + end + end + + # The report criteria for a report of type "PATH_TO_CONVERSION". + class PathToConversionCriteria + include Google::Apis::Core::Hashable + + # The list of 'dfa:activity' values to filter on. + # Corresponds to the JSON property `activityFilters` + # @return [Array] + attr_accessor :activity_filters + + # The list of conversion dimensions the report should include. + # Corresponds to the JSON property `conversionDimensions` + # @return [Array] + attr_accessor :conversion_dimensions + + # The list of custom floodlight variables the report should include. + # Corresponds to the JSON property `customFloodlightVariables` + # @return [Array] + attr_accessor :custom_floodlight_variables + + # The list of custom rich media events to include. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Array] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigId` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :floodlight_config_id + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of per interaction dimensions the report should include. + # Corresponds to the JSON property `perInteractionDimensions` + # @return [Array] + attr_accessor :per_interaction_dimensions + + # The properties of the report. + # Corresponds to the JSON property `reportProperties` + # @return [Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria::ReportProperties] + attr_accessor :report_properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activity_filters = args[:activity_filters] if args.key?(:activity_filters) + @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) + @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) + @report_properties = args[:report_properties] if args.key?(:report_properties) + end + + # The properties of the report. + class ReportProperties + include Google::Apis::Core::Hashable + + # DFA checks to see if a click interaction occurred within the specified period + # of time before a conversion. By default the value is pulled from Floodlight or + # you can manually enter a custom value. Valid values: 1-90. + # Corresponds to the JSON property `clicksLookbackWindow` + # @return [Fixnum] + attr_accessor :clicks_lookback_window + + # DFA checks to see if an impression interaction occurred within the specified + # period of time before a conversion. By default the value is pulled from + # Floodlight or you can manually enter a custom value. Valid values: 1-90. + # Corresponds to the JSON property `impressionsLookbackWindow` + # @return [Fixnum] + attr_accessor :impressions_lookback_window + + # Deprecated: has no effect. + # Corresponds to the JSON property `includeAttributedIPConversions` + # @return [Boolean] + attr_accessor :include_attributed_ip_conversions + alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions + + # Include conversions of users with a DoubleClick cookie but without an exposure. + # That means the user did not click or see an ad from the advertiser within the + # Floodlight group, or that the interaction happened outside the lookback window. + # Corresponds to the JSON property `includeUnattributedCookieConversions` + # @return [Boolean] + attr_accessor :include_unattributed_cookie_conversions + alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions + + # Include conversions that have no associated cookies and no exposures. It’s + # therefore impossible to know how the user was exposed to your ads during the + # lookback window prior to a conversion. + # Corresponds to the JSON property `includeUnattributedIPConversions` + # @return [Boolean] + attr_accessor :include_unattributed_ip_conversions + alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions + + # The maximum number of click interactions to include in the report. Advertisers + # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). + # If another advertiser in your network is paying for E2C, you can have up to 5 + # total exposures per report. + # Corresponds to the JSON property `maximumClickInteractions` + # @return [Fixnum] + attr_accessor :maximum_click_interactions + + # The maximum number of click interactions to include in the report. Advertisers + # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). + # If another advertiser in your network is paying for E2C, you can have up to 5 + # total exposures per report. + # Corresponds to the JSON property `maximumImpressionInteractions` + # @return [Fixnum] + attr_accessor :maximum_impression_interactions + + # The maximum amount of time that can take place between interactions (clicks or + # impressions) by the same user. Valid values: 1-90. + # Corresponds to the JSON property `maximumInteractionGap` + # @return [Fixnum] + attr_accessor :maximum_interaction_gap + + # Enable pivoting on interaction path. + # Corresponds to the JSON property `pivotOnInteractionPath` + # @return [Boolean] + attr_accessor :pivot_on_interaction_path + alias_method :pivot_on_interaction_path?, :pivot_on_interaction_path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @clicks_lookback_window = args[:clicks_lookback_window] if args.key?(:clicks_lookback_window) + @impressions_lookback_window = args[:impressions_lookback_window] if args.key?(:impressions_lookback_window) + @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) + @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) + @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) + @maximum_click_interactions = args[:maximum_click_interactions] if args.key?(:maximum_click_interactions) + @maximum_impression_interactions = args[:maximum_impression_interactions] if args.key?(:maximum_impression_interactions) + @maximum_interaction_gap = args[:maximum_interaction_gap] if args.key?(:maximum_interaction_gap) + @pivot_on_interaction_path = args[:pivot_on_interaction_path] if args.key?(:pivot_on_interaction_path) + end + end + end + + # The report criteria for a report of type "REACH". + class ReachCriteria + include Google::Apis::Core::Hashable + + # Represents an activity group. + # Corresponds to the JSON property `activities` + # @return [Google::Apis::DfareportingV2_7::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV2_7::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV2_7::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Whether to enable all reach dimension combinations in the report. Defaults to + # false. If enabled, the date range of the report should be within the last + # three months. + # Corresponds to the JSON property `enableAllDimensionCombinations` + # @return [Boolean] + attr_accessor :enable_all_dimension_combinations + alias_method :enable_all_dimension_combinations?, :enable_all_dimension_combinations + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of names of Reach By Frequency metrics the report should include. + # Corresponds to the JSON property `reachByFrequencyMetricNames` + # @return [Array] + attr_accessor :reach_by_frequency_metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activities = args[:activities] if args.key?(:activities) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @enable_all_dimension_combinations = args[:enable_all_dimension_combinations] if args.key?(:enable_all_dimension_combinations) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @reach_by_frequency_metric_names = args[:reach_by_frequency_metric_names] if args.key?(:reach_by_frequency_metric_names) + end + end + + # The report's schedule. Can only be set if the report's 'dateRange' is a + # relative date range and the relative date range is not "TODAY". + class Schedule + include Google::Apis::Core::Hashable + + # Whether the schedule is active or not. Must be set to either true or false. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Defines every how many days, weeks or months the report should be run. Needs + # to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY". + # Corresponds to the JSON property `every` + # @return [Fixnum] + attr_accessor :every + + # The expiration date when the scheduled report stops running. + # Corresponds to the JSON property `expirationDate` + # @return [Date] + attr_accessor :expiration_date + + # The interval for which the report is repeated. Note: + # - "DAILY" also requires field "every" to be set. + # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. + # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set. + # Corresponds to the JSON property `repeats` + # @return [String] + attr_accessor :repeats + + # List of week days "WEEKLY" on which scheduled reports should run. + # Corresponds to the JSON property `repeatsOnWeekDays` + # @return [Array] + attr_accessor :repeats_on_week_days + + # Enum to define for "MONTHLY" scheduled reports whether reports should be + # repeated on the same day of the month as "startDate" or the same day of the + # week of the month. + # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" + # would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" + # would run subsequent reports on the first Monday of the month. + # Corresponds to the JSON property `runsOnDayOfMonth` + # @return [String] + attr_accessor :runs_on_day_of_month + + # Start date of date range for which scheduled reports should be run. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @every = args[:every] if args.key?(:every) + @expiration_date = args[:expiration_date] if args.key?(:expiration_date) + @repeats = args[:repeats] if args.key?(:repeats) + @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days) + @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + end + + # Represents fields that are compatible to be selected for a report of type " + # STANDARD". + class ReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting#reportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected as activity metrics to pivot on in + # the "activities" section of the report. + # Corresponds to the JSON property `pivotedActivityMetrics` + # @return [Array] + attr_accessor :pivoted_activity_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) + end + end + + # Represents the list of reports. + class ReportList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The reports returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#reportList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through reports. To retrieve the next page of + # results, set the next request's "pageToken" to the value of this field. The + # page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Reporting Configuration + class ReportsConfiguration + include Google::Apis::Core::Hashable + + # Whether the exposure to conversion report is enabled. This report shows + # detailed pathway information on up to 10 of the most recent ad exposures seen + # by a user before converting. + # Corresponds to the JSON property `exposureToConversionEnabled` + # @return [Boolean] + attr_accessor :exposure_to_conversion_enabled + alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV2_7::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Report generation time zone ID of this account. This is a required field that + # can only be changed by a superuser. + # Acceptable values are: + # - "1" for "America/New_York" + # - "2" for "Europe/London" + # - "3" for "Europe/Paris" + # - "4" for "Africa/Johannesburg" + # - "5" for "Asia/Jerusalem" + # - "6" for "Asia/Shanghai" + # - "7" for "Asia/Hong_Kong" + # - "8" for "Asia/Tokyo" + # - "9" for "Australia/Sydney" + # - "10" for "Asia/Dubai" + # - "11" for "America/Los_Angeles" + # - "12" for "Pacific/Auckland" + # - "13" for "America/Sao_Paulo" + # Corresponds to the JSON property `reportGenerationTimeZoneId` + # @return [String] + attr_accessor :report_generation_time_zone_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @report_generation_time_zone_id = args[:report_generation_time_zone_id] if args.key?(:report_generation_time_zone_id) + end + end + + # Rich Media Exit Override. + class RichMediaExitOverride + include Google::Apis::Core::Hashable + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV2_7::ClickThroughUrl] + attr_accessor :click_through_url + + # Whether to use the clickThroughUrl. If false, the creative-level exit will be + # used. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # ID for the override to refer to a specific exit in the creative. + # Corresponds to the JSON property `exitId` + # @return [String] + attr_accessor :exit_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @enabled = args[:enabled] if args.key?(:enabled) + @exit_id = args[:exit_id] if args.key?(:exit_id) + end + end + + # A rule associates an asset with a targeting template for asset-level targeting. + # Applicable to INSTREAM_VIDEO creatives. + class Rule + include Google::Apis::Core::Hashable + + # A creativeAssets[].id. This should refer to one of the parent assets in this + # creative. This is a required field. + # Corresponds to the JSON property `assetId` + # @return [String] + attr_accessor :asset_id + + # A user-friendly name for this rule. This is a required field. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A targeting template ID. The targeting from the targeting template will be + # used to determine whether this asset should be served. This is a required + # field. + # Corresponds to the JSON property `targetingTemplateId` + # @return [String] + attr_accessor :targeting_template_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_id = args[:asset_id] if args.key?(:asset_id) + @name = args[:name] if args.key?(:name) + @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) + end + end + + # Contains properties of a site. + class Site + include Google::Apis::Core::Hashable + + # Account ID of this site. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this site is approved. + # Corresponds to the JSON property `approved` + # @return [Boolean] + attr_accessor :approved + alias_method :approved?, :approved + + # Directory site associated with this site. This is a required field that is + # read-only after insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [String] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # ID of this site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :id_dimension_value + + # Key name of this site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `keyName` + # @return [String] + attr_accessor :key_name + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#site". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this site.This is a required field. Must be less than 128 characters + # long. If this site is under a subaccount, the name must be unique among sites + # of the same subaccount. Otherwise, this site is a top-level site, and the name + # must be unique among top-level sites of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Site contacts. + # Corresponds to the JSON property `siteContacts` + # @return [Array] + attr_accessor :site_contacts + + # Site Settings + # Corresponds to the JSON property `siteSettings` + # @return [Google::Apis::DfareportingV2_7::SiteSettings] + attr_accessor :site_settings + + # Subaccount ID of this site. This is a read-only field that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @approved = args[:approved] if args.key?(:approved) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_name = args[:key_name] if args.key?(:key_name) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @site_contacts = args[:site_contacts] if args.key?(:site_contacts) + @site_settings = args[:site_settings] if args.key?(:site_settings) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Site Contact + class SiteContact + include Google::Apis::Core::Hashable + + # Address of this site contact. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Site contact type. + # Corresponds to the JSON property `contactType` + # @return [String] + attr_accessor :contact_type + + # Email address of this site contact. This is a required field. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # First name of this site contact. + # Corresponds to the JSON property `firstName` + # @return [String] + attr_accessor :first_name + + # ID of this site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Last name of this site contact. + # Corresponds to the JSON property `lastName` + # @return [String] + attr_accessor :last_name + + # Primary phone number of this site contact. + # Corresponds to the JSON property `phone` + # @return [String] + attr_accessor :phone + + # Title or designation of this site contact. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @contact_type = args[:contact_type] if args.key?(:contact_type) + @email = args[:email] if args.key?(:email) + @first_name = args[:first_name] if args.key?(:first_name) + @id = args[:id] if args.key?(:id) + @last_name = args[:last_name] if args.key?(:last_name) + @phone = args[:phone] if args.key?(:phone) + @title = args[:title] if args.key?(:title) + end + end + + # Site Settings + class SiteSettings + include Google::Apis::Core::Hashable + + # Whether active view creatives are disabled for this site. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # Creative Settings + # Corresponds to the JSON property `creativeSettings` + # @return [Google::Apis::DfareportingV2_7::CreativeSettings] + attr_accessor :creative_settings + + # Whether brand safe ads are disabled for this site. + # Corresponds to the JSON property `disableBrandSafeAds` + # @return [Boolean] + attr_accessor :disable_brand_safe_ads + alias_method :disable_brand_safe_ads?, :disable_brand_safe_ads + + # Whether new cookies are disabled for this site. + # Corresponds to the JSON property `disableNewCookie` + # @return [Boolean] + attr_accessor :disable_new_cookie + alias_method :disable_new_cookie?, :disable_new_cookie + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV2_7::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Tag Settings + # Corresponds to the JSON property `tagSetting` + # @return [Google::Apis::DfareportingV2_7::TagSetting] + attr_accessor :tag_setting + + # Whether Verification and ActiveView for in-stream video creatives are disabled + # by default for new placements created under this site. This value will be used + # to populate the placement.videoActiveViewOptOut field, when no value is + # specified for the new placement. + # Corresponds to the JSON property `videoActiveViewOptOutTemplate` + # @return [Boolean] + attr_accessor :video_active_view_opt_out_template + alias_method :video_active_view_opt_out_template?, :video_active_view_opt_out_template + + # Default VPAID adapter setting for new placements created under this site. This + # value will be used to populate the placements.vpaidAdapterChoice field, when + # no value is specified for the new placement. Controls which VPAID format the + # measurement adapter will use for in-stream video creatives assigned to the + # placement. The publisher's specifications will typically determine this + # setting. For VPAID creatives, the adapter format will match the VPAID format ( + # HTML5 VPAID creatives use the HTML5 adapter, and Flash VPAID creatives use the + # Flash adapter). + # Corresponds to the JSON property `vpaidAdapterChoiceTemplate` + # @return [String] + attr_accessor :vpaid_adapter_choice_template + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @creative_settings = args[:creative_settings] if args.key?(:creative_settings) + @disable_brand_safe_ads = args[:disable_brand_safe_ads] if args.key?(:disable_brand_safe_ads) + @disable_new_cookie = args[:disable_new_cookie] if args.key?(:disable_new_cookie) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @tag_setting = args[:tag_setting] if args.key?(:tag_setting) + @video_active_view_opt_out_template = args[:video_active_view_opt_out_template] if args.key?(:video_active_view_opt_out_template) + @vpaid_adapter_choice_template = args[:vpaid_adapter_choice_template] if args.key?(:vpaid_adapter_choice_template) + end + end + + # Site List Response + class SitesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#sitesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Site collection. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @sites = args[:sites] if args.key?(:sites) + end + end + + # Represents the dimensions of ads, placements, creatives, or creative assets. + class Size + include Google::Apis::Core::Hashable + + # Height of this size. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # IAB standard size. This is a read-only, auto-generated field. + # Corresponds to the JSON property `iab` + # @return [Boolean] + attr_accessor :iab + alias_method :iab?, :iab + + # ID of this size. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#size". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Width of this size. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height = args[:height] if args.key?(:height) + @iab = args[:iab] if args.key?(:iab) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @width = args[:width] if args.key?(:width) + end + end + + # Size List Response + class SizesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#sizesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Size collection. + # Corresponds to the JSON property `sizes` + # @return [Array] + attr_accessor :sizes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @sizes = args[:sizes] if args.key?(:sizes) + end + end + + # Skippable Settings + class SkippableSetting + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#skippableSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Video Offset + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DfareportingV2_7::VideoOffset] + attr_accessor :progress_offset + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV2_7::VideoOffset] + attr_accessor :skip_offset + + # Whether the user can skip creatives served to this placement. + # Corresponds to the JSON property `skippable` + # @return [Boolean] + attr_accessor :skippable + alias_method :skippable?, :skippable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @progress_offset = args[:progress_offset] if args.key?(:progress_offset) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @skippable = args[:skippable] if args.key?(:skippable) + end + end + + # Represents a sorted dimension. + class SortedDimension + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#sortedDimension. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The name of the dimension. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # An optional sort order for the dimension column. + # Corresponds to the JSON property `sortOrder` + # @return [String] + attr_accessor :sort_order + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @sort_order = args[:sort_order] if args.key?(:sort_order) + end + end + + # Contains properties of a DCM subaccount. + class Subaccount + include Google::Apis::Core::Hashable + + # ID of the account that contains this subaccount. This is a read-only field + # that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # IDs of the available user role permissions for this subaccount. + # Corresponds to the JSON property `availablePermissionIds` + # @return [Array] + attr_accessor :available_permission_ids + + # ID of this subaccount. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#subaccount". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this subaccount. This is a required field. Must be less than 128 + # characters long and be unique among subaccounts of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Subaccount List Response + class SubaccountsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#subaccountsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Subaccount collection. + # Corresponds to the JSON property `subaccounts` + # @return [Array] + attr_accessor :subaccounts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @subaccounts = args[:subaccounts] if args.key?(:subaccounts) + end + end + + # Placement Tag Data + class TagData + include Google::Apis::Core::Hashable + + # Ad associated with this placement tag. + # Corresponds to the JSON property `adId` + # @return [String] + attr_accessor :ad_id + + # Tag string to record a click. + # Corresponds to the JSON property `clickTag` + # @return [String] + attr_accessor :click_tag + + # Creative associated with this placement tag. + # Corresponds to the JSON property `creativeId` + # @return [String] + attr_accessor :creative_id + + # TagData tag format of this tag. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # Tag string for serving an ad. + # Corresponds to the JSON property `impressionTag` + # @return [String] + attr_accessor :impression_tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ad_id = args[:ad_id] if args.key?(:ad_id) + @click_tag = args[:click_tag] if args.key?(:click_tag) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @format = args[:format] if args.key?(:format) + @impression_tag = args[:impression_tag] if args.key?(:impression_tag) + end + end + + # Tag Settings + class TagSetting + include Google::Apis::Core::Hashable + + # Additional key-values to be included in tags. Each key-value pair must be of + # the form key=value, and pairs must be separated by a semicolon (;). Keys and + # values must not contain commas. For example, id=2;color=red is a valid value + # for this field. + # Corresponds to the JSON property `additionalKeyValues` + # @return [String] + attr_accessor :additional_key_values + + # Whether static landing page URLs should be included in the tags. This setting + # applies only to placements. + # Corresponds to the JSON property `includeClickThroughUrls` + # @return [Boolean] + attr_accessor :include_click_through_urls + alias_method :include_click_through_urls?, :include_click_through_urls + + # Whether click-tracking string should be included in the tags. + # Corresponds to the JSON property `includeClickTracking` + # @return [Boolean] + attr_accessor :include_click_tracking + alias_method :include_click_tracking?, :include_click_tracking + + # Option specifying how keywords are embedded in ad tags. This setting can be + # used to specify whether keyword placeholders are inserted in placement tags + # for this site. Publishers can then add keywords to those placeholders. + # Corresponds to the JSON property `keywordOption` + # @return [String] + attr_accessor :keyword_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_key_values = args[:additional_key_values] if args.key?(:additional_key_values) + @include_click_through_urls = args[:include_click_through_urls] if args.key?(:include_click_through_urls) + @include_click_tracking = args[:include_click_tracking] if args.key?(:include_click_tracking) + @keyword_option = args[:keyword_option] if args.key?(:keyword_option) + end + end + + # Dynamic and Image Tag Settings. + class TagSettings + include Google::Apis::Core::Hashable + + # Whether dynamic floodlight tags are enabled. + # Corresponds to the JSON property `dynamicTagEnabled` + # @return [Boolean] + attr_accessor :dynamic_tag_enabled + alias_method :dynamic_tag_enabled?, :dynamic_tag_enabled + + # Whether image tags are enabled. + # Corresponds to the JSON property `imageTagEnabled` + # @return [Boolean] + attr_accessor :image_tag_enabled + alias_method :image_tag_enabled?, :image_tag_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dynamic_tag_enabled = args[:dynamic_tag_enabled] if args.key?(:dynamic_tag_enabled) + @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) + end + end + + # Target Window. + class TargetWindow + include Google::Apis::Core::Hashable + + # User-entered value. + # Corresponds to the JSON property `customHtml` + # @return [String] + attr_accessor :custom_html + + # Type of browser window for which the backup image of the flash creative can be + # displayed. + # Corresponds to the JSON property `targetWindowOption` + # @return [String] + attr_accessor :target_window_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_html = args[:custom_html] if args.key?(:custom_html) + @target_window_option = args[:target_window_option] if args.key?(:target_window_option) + end + end + + # Contains properties of a targetable remarketing list. Remarketing enables you + # to create lists of users who have performed specific actions on a site, then + # target ads to members of those lists. This resource is a read-only view of a + # remarketing list to be used to faciliate targeting ads to specific lists. + # Remarketing lists that are owned by your advertisers and those that are shared + # to your advertisers or account are accessible via this resource. To manage + # remarketing lists that are owned by your advertisers, use the RemarketingLists + # resource. + class TargetableRemarketingList + include Google::Apis::Core::Hashable + + # Account ID of this remarketing list. This is a read-only, auto-generated field + # that is only returned in GET requests. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this targetable remarketing list is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Dimension value for the advertiser ID that owns this targetable remarketing + # list. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Targetable remarketing list description. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Targetable remarketing list ID. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetableRemarketingList". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Number of days that a user should remain in the targetable remarketing list + # without an impression. + # Corresponds to the JSON property `lifeSpan` + # @return [String] + attr_accessor :life_span + + # Number of users currently in the list. This is a read-only field. + # Corresponds to the JSON property `listSize` + # @return [String] + attr_accessor :list_size + + # Product from which this targetable remarketing list was originated. + # Corresponds to the JSON property `listSource` + # @return [String] + attr_accessor :list_source + + # Name of the targetable remarketing list. Is no greater than 128 characters + # long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this remarketing list. This is a read-only, auto-generated + # field that is only returned in GET requests. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @life_span = args[:life_span] if args.key?(:life_span) + @list_size = args[:list_size] if args.key?(:list_size) + @list_source = args[:list_source] if args.key?(:list_source) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Targetable remarketing list response + class TargetableRemarketingListsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetableRemarketingListsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Targetable remarketing list collection. + # Corresponds to the JSON property `targetableRemarketingLists` + # @return [Array] + attr_accessor :targetable_remarketing_lists + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @targetable_remarketing_lists = args[:targetable_remarketing_lists] if args.key?(:targetable_remarketing_lists) + end + end + + # Contains properties of a targeting template. A targeting template encapsulates + # targeting information which can be reused across multiple ads. + class TargetingTemplate + include Google::Apis::Core::Hashable + + # Account ID of this targeting template. This field, if left unset, will be auto- + # generated on insert and is read-only after insert. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Advertiser ID of this targeting template. This is a required field on insert + # and is read-only after insert. + # Corresponds to the JSON property `advertiserId` + # @return [String] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV2_7::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV2_7::DayPartTargeting] + attr_accessor :day_part_targeting + + # Geographical Targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::DfareportingV2_7::GeoTargeting] + attr_accessor :geo_targeting + + # ID of this targeting template. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV2_7::KeyValueTargetingExpression] + attr_accessor :key_value_targeting_expression + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetingTemplate". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language Targeting. + # Corresponds to the JSON property `languageTargeting` + # @return [Google::Apis::DfareportingV2_7::LanguageTargeting] + attr_accessor :language_targeting + + # Remarketing List Targeting Expression. + # Corresponds to the JSON property `listTargetingExpression` + # @return [Google::Apis::DfareportingV2_7::ListTargetingExpression] + attr_accessor :list_targeting_expression + + # Name of this targeting template. This field is required. It must be less than + # 256 characters long and unique within an advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this targeting template. This field, if left unset, will be + # auto-generated on insert and is read-only after insert. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV2_7::TechnologyTargeting] + attr_accessor :technology_targeting + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) + @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) + @id = args[:id] if args.key?(:id) + @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) + @kind = args[:kind] if args.key?(:kind) + @language_targeting = args[:language_targeting] if args.key?(:language_targeting) + @list_targeting_expression = args[:list_targeting_expression] if args.key?(:list_targeting_expression) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) + end + end + + # Targeting Template List Response + class TargetingTemplatesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetingTemplatesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Targeting template collection. + # Corresponds to the JSON property `targetingTemplates` + # @return [Array] + attr_accessor :targeting_templates + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @targeting_templates = args[:targeting_templates] if args.key?(:targeting_templates) + end + end + + # Technology Targeting. + class TechnologyTargeting + include Google::Apis::Core::Hashable + + # Browsers that this ad targets. For each browser either set browserVersionId or + # dartId along with the version numbers. If both are specified, only + # browserVersionId will be used. The other fields are populated automatically + # when the ad is inserted or updated. + # Corresponds to the JSON property `browsers` + # @return [Array] + attr_accessor :browsers + + # Connection types that this ad targets. For each connection type only id is + # required. The other fields are populated automatically when the ad is inserted + # or updated. + # Corresponds to the JSON property `connectionTypes` + # @return [Array] + attr_accessor :connection_types + + # Mobile carriers that this ad targets. For each mobile carrier only id is + # required, and the other fields are populated automatically when the ad is + # inserted or updated. If targeting a mobile carrier, do not set targeting for + # any zip codes. + # Corresponds to the JSON property `mobileCarriers` + # @return [Array] + attr_accessor :mobile_carriers + + # Operating system versions that this ad targets. To target all versions, use + # operatingSystems. For each operating system version, only id is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting an operating system version, do not set targeting for the + # corresponding operating system in operatingSystems. + # Corresponds to the JSON property `operatingSystemVersions` + # @return [Array] + attr_accessor :operating_system_versions + + # Operating systems that this ad targets. To target specific versions, use + # operatingSystemVersions. For each operating system only dartId is required. + # The other fields are populated automatically when the ad is inserted or + # updated. If targeting an operating system, do not set targeting for operating + # system versions for the same operating system. + # Corresponds to the JSON property `operatingSystems` + # @return [Array] + attr_accessor :operating_systems + + # Platform types that this ad targets. For example, desktop, mobile, or tablet. + # For each platform type, only id is required, and the other fields are + # populated automatically when the ad is inserted or updated. + # Corresponds to the JSON property `platformTypes` + # @return [Array] + attr_accessor :platform_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browsers = args[:browsers] if args.key?(:browsers) + @connection_types = args[:connection_types] if args.key?(:connection_types) + @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) + @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) + @operating_systems = args[:operating_systems] if args.key?(:operating_systems) + @platform_types = args[:platform_types] if args.key?(:platform_types) + end + end + + # Third Party Authentication Token + class ThirdPartyAuthenticationToken + include Google::Apis::Core::Hashable + + # Name of the third-party authentication token. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value of the third-party authentication token. This is a read-only, auto- + # generated field. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Third-party Tracking URL. + class ThirdPartyTrackingUrl + include Google::Apis::Core::Hashable + + # Third-party URL type for in-stream video creatives. + # Corresponds to the JSON property `thirdPartyUrlType` + # @return [String] + attr_accessor :third_party_url_type + + # URL for the specified third-party URL type. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @third_party_url_type = args[:third_party_url_type] if args.key?(:third_party_url_type) + @url = args[:url] if args.key?(:url) + end + end + + # Transcode Settings + class TranscodeSetting + include Google::Apis::Core::Hashable + + # Whitelist of video formats to be served to this placement. Set this list to + # null or empty to serve all video formats. + # Corresponds to the JSON property `enabledVideoFormats` + # @return [Array] + attr_accessor :enabled_video_formats + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#transcodeSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled_video_formats = args[:enabled_video_formats] if args.key?(:enabled_video_formats) + @kind = args[:kind] if args.key?(:kind) + end + end + + # User Defined Variable configuration. + class UserDefinedVariableConfiguration + include Google::Apis::Core::Hashable + + # Data type for the variable. This is a required field. + # Corresponds to the JSON property `dataType` + # @return [String] + attr_accessor :data_type + + # User-friendly name for the variable which will appear in reports. This is a + # required field, must be less than 64 characters long, and cannot contain the + # following characters: ""<>". + # Corresponds to the JSON property `reportName` + # @return [String] + attr_accessor :report_name + + # Variable name in the tag. This is a required field. + # Corresponds to the JSON property `variableType` + # @return [String] + attr_accessor :variable_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_type = args[:data_type] if args.key?(:data_type) + @report_name = args[:report_name] if args.key?(:report_name) + @variable_type = args[:variable_type] if args.key?(:variable_type) + end + end + + # Represents a UserProfile resource. + class UserProfile + include Google::Apis::Core::Hashable + + # The account ID to which this profile belongs. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # The account name this profile belongs to. + # Corresponds to the JSON property `accountName` + # @return [String] + attr_accessor :account_name + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The kind of resource this is, in this case dfareporting#userProfile. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The unique ID of the user profile. + # Corresponds to the JSON property `profileId` + # @return [String] + attr_accessor :profile_id + + # The sub account ID this profile belongs to if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [String] + attr_accessor :sub_account_id + + # The sub account name this profile belongs to if applicable. + # Corresponds to the JSON property `subAccountName` + # @return [String] + attr_accessor :sub_account_name + + # The user name. + # Corresponds to the JSON property `userName` + # @return [String] + attr_accessor :user_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @account_name = args[:account_name] if args.key?(:account_name) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + @profile_id = args[:profile_id] if args.key?(:profile_id) + @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) + @sub_account_name = args[:sub_account_name] if args.key?(:sub_account_name) + @user_name = args[:user_name] if args.key?(:user_name) + end + end + + # Represents the list of user profiles. + class UserProfileList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The user profiles returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#userProfileList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of auser role, which is used to manage user access. + class UserRole + include Google::Apis::Core::Hashable + + # Account ID of this user role. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Whether this is a default user role. Default user roles are created by the + # system for the account/subaccount and cannot be modified or deleted. Each + # default user role comes with a basic set of preassigned permissions. + # Corresponds to the JSON property `defaultUserRole` + # @return [Boolean] + attr_accessor :default_user_role + alias_method :default_user_role?, :default_user_role + + # ID of this user role. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRole". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role. This is a required field. Must be less than 256 + # characters long. If this user role is under a subaccount, the name must be + # unique among sites of the same subaccount. Otherwise, this user role is a top- + # level user role, and the name must be unique among top-level user roles of the + # same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the user role that this user role is based on or copied from. This is a + # required field. + # Corresponds to the JSON property `parentUserRoleId` + # @return [String] + attr_accessor :parent_user_role_id + + # List of permissions associated with this user role. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + # Subaccount ID of this user role. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [String] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @default_user_role = args[:default_user_role] if args.key?(:default_user_role) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @parent_user_role_id = args[:parent_user_role_id] if args.key?(:parent_user_role_id) + @permissions = args[:permissions] if args.key?(:permissions) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Contains properties of a user role permission. + class UserRolePermission + include Google::Apis::Core::Hashable + + # Levels of availability for a user role permission. + # Corresponds to the JSON property `availability` + # @return [String] + attr_accessor :availability + + # ID of this user role permission. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermission". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role permission. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the permission group that this user role permission belongs to. + # Corresponds to the JSON property `permissionGroupId` + # @return [String] + attr_accessor :permission_group_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @availability = args[:availability] if args.key?(:availability) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) + end + end + + # Represents a grouping of related user role permissions. + class UserRolePermissionGroup + include Google::Apis::Core::Hashable + + # ID of this user role permission. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role permission group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # User Role Permission Group List Response + class UserRolePermissionGroupsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # User role permission group collection. + # Corresponds to the JSON property `userRolePermissionGroups` + # @return [Array] + attr_accessor :user_role_permission_groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @user_role_permission_groups = args[:user_role_permission_groups] if args.key?(:user_role_permission_groups) + end + end + + # User Role Permission List Response + class UserRolePermissionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # User role permission collection. + # Corresponds to the JSON property `userRolePermissions` + # @return [Array] + attr_accessor :user_role_permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @user_role_permissions = args[:user_role_permissions] if args.key?(:user_role_permissions) + end + end + + # User Role List Response + class UserRolesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # User role collection. + # Corresponds to the JSON property `userRoles` + # @return [Array] + attr_accessor :user_roles + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @user_roles = args[:user_roles] if args.key?(:user_roles) + end + end + + # Contains information about supported video formats. + class VideoFormat + include Google::Apis::Core::Hashable + + # File type of the video format. + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # ID of the video format. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoFormat". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `resolution` + # @return [Google::Apis::DfareportingV2_7::Size] + attr_accessor :resolution + + # The target bit rate of this video format. + # Corresponds to the JSON property `targetBitRate` + # @return [Fixnum] + attr_accessor :target_bit_rate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_type = args[:file_type] if args.key?(:file_type) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @resolution = args[:resolution] if args.key?(:resolution) + @target_bit_rate = args[:target_bit_rate] if args.key?(:target_bit_rate) + end + end + + # Video Format List Response + class VideoFormatsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoFormatsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Video format collection. + # Corresponds to the JSON property `videoFormats` + # @return [Array] + attr_accessor :video_formats + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @video_formats = args[:video_formats] if args.key?(:video_formats) + end + end + + # Video Offset + class VideoOffset + include Google::Apis::Core::Hashable + + # Duration, as a percentage of video duration. Do not set when offsetSeconds is + # set. + # Corresponds to the JSON property `offsetPercentage` + # @return [Fixnum] + attr_accessor :offset_percentage + + # Duration, in seconds. Do not set when offsetPercentage is set. + # Corresponds to the JSON property `offsetSeconds` + # @return [Fixnum] + attr_accessor :offset_seconds + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @offset_percentage = args[:offset_percentage] if args.key?(:offset_percentage) + @offset_seconds = args[:offset_seconds] if args.key?(:offset_seconds) + end + end + + # Video Settings + class VideoSettings + include Google::Apis::Core::Hashable + + # Companion Settings + # Corresponds to the JSON property `companionSettings` + # @return [Google::Apis::DfareportingV2_7::CompanionSetting] + attr_accessor :companion_settings + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoSettings". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Skippable Settings + # Corresponds to the JSON property `skippableSettings` + # @return [Google::Apis::DfareportingV2_7::SkippableSetting] + attr_accessor :skippable_settings + + # Transcode Settings + # Corresponds to the JSON property `transcodeSettings` + # @return [Google::Apis::DfareportingV2_7::TranscodeSetting] + attr_accessor :transcode_settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @companion_settings = args[:companion_settings] if args.key?(:companion_settings) + @kind = args[:kind] if args.key?(:kind) + @skippable_settings = args[:skippable_settings] if args.key?(:skippable_settings) + @transcode_settings = args[:transcode_settings] if args.key?(:transcode_settings) + end + end + end + end +end diff --git a/generated/google/apis/dfareporting_v2_7/representations.rb b/generated/google/apis/dfareporting_v2_7/representations.rb new file mode 100644 index 000000000..d1592039a --- /dev/null +++ b/generated/google/apis/dfareporting_v2_7/representations.rb @@ -0,0 +1,4243 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV2_7 + + class Account + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountActiveAdSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermission + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountUserProfile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountUserProfilesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Activities + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Ad + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdSlot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Advertiser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertisersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudienceSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudienceSegmentGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Browser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BrowsersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Campaign + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignCreativeAssociation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignCreativeAssociationsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChangeLog + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChangeLogsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CitiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class City + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickThroughUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickThroughUrlSuffixProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompanionClickThroughOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompanionSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConnectionType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConnectionTypesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentCategoriesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentCategory + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Conversion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchInsertRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchInsertResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CountriesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Country + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Creative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAsset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetSelection + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeCustomEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldValuesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroupAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeOptimizationConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeRotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CrossDimensionReachReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomFloodlightVariable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomRichMediaEvents + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DayPartTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DefaultClickThroughEventTagProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeliverySchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DfpSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValueList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValueRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySite + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContactAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContactsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySitesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DynamicTargetingKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DynamicTargetingKeysListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EncryptionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTagOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTagsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class File + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Urls + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class FileList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Flight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivitiesGenerateTagResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivitiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityDynamicTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityPublisherDynamicTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightConfigurationsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FrequencyCap + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FsCommand + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GeoTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventoryItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventoryItemsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class KeyValueTargetingExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LandingPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LandingPagesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Language + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguageTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguagesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LastModifiedInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationClause + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationTerm + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListTargetingExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LookbackConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metro + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetrosListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MobileCarrier + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MobileCarriersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OffsetPosition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OmnitureSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemVersion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemVersionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OptimizationActivity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Order + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderDocument + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderDocumentsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrdersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PathToConversionReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Placement + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementStrategiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementsGenerateTagsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlatformType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlatformTypesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PopupWindowProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PostalCode + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PostalCodesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Pricing + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PricingSchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PricingSchedulePricingPeriod + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Project + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProjectsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReachReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Recipient + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Region + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RegionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingListShare + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingListsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Report + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Criteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CrossDimensionReachCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Delivery + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + class ReportProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class PathToConversionCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + class ReportProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReachCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Schedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportsConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RichMediaExitOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Rule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Site + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SitesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Size + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SizesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SkippableSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SortedDimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Subaccount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SubaccountsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetWindow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetableRemarketingList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetableRemarketingListsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetingTemplate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetingTemplatesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TechnologyTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyAuthenticationToken + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyTrackingUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TranscodeSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserDefinedVariableConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserProfile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserProfileList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRole + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermission + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoFormat + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoFormatsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoOffset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Account + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permission_ids, as: 'accountPermissionIds' + property :account_profile, as: 'accountProfile' + property :active, as: 'active' + property :active_ads_limit_tier, as: 'activeAdsLimitTier' + property :active_view_opt_out, as: 'activeViewOptOut' + collection :available_permission_ids, as: 'availablePermissionIds' + property :country_id, as: 'countryId' + property :currency_id, as: 'currencyId' + property :default_creative_size_id, as: 'defaultCreativeSizeId' + property :description, as: 'description' + property :id, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :maximum_image_size, as: 'maximumImageSize' + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :reports_configuration, as: 'reportsConfiguration', class: Google::Apis::DfareportingV2_7::ReportsConfiguration, decorator: Google::Apis::DfareportingV2_7::ReportsConfiguration::Representation + + property :share_reports_with_twitter, as: 'shareReportsWithTwitter' + property :teaser_size_limit, as: 'teaserSizeLimit' + end + end + + class AccountActiveAdSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active_ads, as: 'activeAds' + property :active_ads_limit_tier, as: 'activeAdsLimitTier' + property :available_ads, as: 'availableAds' + property :kind, as: 'kind' + end + end + + class AccountPermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_profiles, as: 'accountProfiles' + property :id, as: 'id' + property :kind, as: 'kind' + property :level, as: 'level' + property :name, as: 'name' + property :permission_group_id, as: 'permissionGroupId' + end + end + + class AccountPermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class AccountPermissionGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permission_groups, as: 'accountPermissionGroups', class: Google::Apis::DfareportingV2_7::AccountPermissionGroup, decorator: Google::Apis::DfareportingV2_7::AccountPermissionGroup::Representation + + property :kind, as: 'kind' + end + end + + class AccountPermissionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permissions, as: 'accountPermissions', class: Google::Apis::DfareportingV2_7::AccountPermission, decorator: Google::Apis::DfareportingV2_7::AccountPermission::Representation + + property :kind, as: 'kind' + end + end + + class AccountUserProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active, as: 'active' + property :advertiser_filter, as: 'advertiserFilter', class: Google::Apis::DfareportingV2_7::ObjectFilter, decorator: Google::Apis::DfareportingV2_7::ObjectFilter::Representation + + property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV2_7::ObjectFilter, decorator: Google::Apis::DfareportingV2_7::ObjectFilter::Representation + + property :comments, as: 'comments' + property :email, as: 'email' + property :id, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :name, as: 'name' + property :site_filter, as: 'siteFilter', class: Google::Apis::DfareportingV2_7::ObjectFilter, decorator: Google::Apis::DfareportingV2_7::ObjectFilter::Representation + + property :subaccount_id, as: 'subaccountId' + property :trafficker_type, as: 'traffickerType' + property :user_access_type, as: 'userAccessType' + property :user_role_filter, as: 'userRoleFilter', class: Google::Apis::DfareportingV2_7::ObjectFilter, decorator: Google::Apis::DfareportingV2_7::ObjectFilter::Representation + + property :user_role_id, as: 'userRoleId' + end + end + + class AccountUserProfilesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_user_profiles, as: 'accountUserProfiles', class: Google::Apis::DfareportingV2_7::AccountUserProfile, decorator: Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AccountsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :accounts, as: 'accounts', class: Google::Apis::DfareportingV2_7::Account, decorator: Google::Apis::DfareportingV2_7::Account::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Activities + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :filters, as: 'filters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + collection :metric_names, as: 'metricNames' + end + end + + class Ad + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :archived, as: 'archived' + property :audience_segment_id, as: 'audienceSegmentId' + property :campaign_id, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_7::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrl::Representation + + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties::Representation + + property :comments, as: 'comments' + property :compatibility, as: 'compatibility' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_7::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_7::CreativeGroupAssignment::Representation + + property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV2_7::CreativeRotation, decorator: Google::Apis::DfareportingV2_7::CreativeRotation::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_7::DayPartTargeting, decorator: Google::Apis::DfareportingV2_7::DayPartTargeting::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties::Representation + + property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV2_7::DeliverySchedule, decorator: Google::Apis::DfareportingV2_7::DeliverySchedule::Representation + + property :dynamic_click_tracker, as: 'dynamicClickTracker' + property :end_time, as: 'endTime', type: DateTime + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_7::EventTagOverride, decorator: Google::Apis::DfareportingV2_7::EventTagOverride::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_7::GeoTargeting, decorator: Google::Apis::DfareportingV2_7::GeoTargeting::Representation + + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_7::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_7::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_7::LanguageTargeting, decorator: Google::Apis::DfareportingV2_7::LanguageTargeting::Representation + + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :name, as: 'name' + collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV2_7::PlacementAssignment, decorator: Google::Apis::DfareportingV2_7::PlacementAssignment::Representation + + property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV2_7::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_7::ListTargetingExpression::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :start_time, as: 'startTime', type: DateTime + + property :subaccount_id, as: 'subaccountId' + property :targeting_template_id, as: 'targetingTemplateId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV2_7::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_7::TechnologyTargeting::Representation + + property :type, as: 'type' + end + end + + class AdSlot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :height, as: 'height' + property :linked_placement_id, as: 'linkedPlacementId' + property :name, as: 'name' + property :payment_source_type, as: 'paymentSourceType' + property :primary, as: 'primary' + property :width, as: 'width' + end + end + + class AdsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ads, as: 'ads', class: Google::Apis::DfareportingV2_7::Ad, decorator: Google::Apis::DfareportingV2_7::Ad::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Advertiser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_group_id, as: 'advertiserGroupId' + property :click_through_url_suffix, as: 'clickThroughUrlSuffix' + property :default_click_through_event_tag_id, as: 'defaultClickThroughEventTagId' + property :default_email, as: 'defaultEmail' + property :floodlight_configuration_id, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :original_floodlight_configuration_id, as: 'originalFloodlightConfigurationId' + property :status, as: 'status' + property :subaccount_id, as: 'subaccountId' + property :suspended, as: 'suspended' + end + end + + class AdvertiserGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class AdvertiserGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertiser_groups, as: 'advertiserGroups', class: Google::Apis::DfareportingV2_7::AdvertiserGroup, decorator: Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AdvertisersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV2_7::Advertiser, decorator: Google::Apis::DfareportingV2_7::Advertiser::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AudienceSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allocation, as: 'allocation' + property :id, as: 'id' + property :name, as: 'name' + end + end + + class AudienceSegmentGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audience_segments, as: 'audienceSegments', class: Google::Apis::DfareportingV2_7::AudienceSegment, decorator: Google::Apis::DfareportingV2_7::AudienceSegment::Representation + + property :id, as: 'id' + property :name, as: 'name' + end + end + + class Browser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :browser_version_id, as: 'browserVersionId' + property :dart_id, as: 'dartId' + property :kind, as: 'kind' + property :major_version, as: 'majorVersion' + property :minor_version, as: 'minorVersion' + property :name, as: 'name' + end + end + + class BrowsersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV2_7::Browser, decorator: Google::Apis::DfareportingV2_7::Browser::Representation + + property :kind, as: 'kind' + end + end + + class Campaign + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration::Representation + + property :advertiser_group_id, as: 'advertiserGroupId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :archived, as: 'archived' + collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV2_7::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV2_7::AudienceSegmentGroup::Representation + + property :billing_invoice_code, as: 'billingInvoiceCode' + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties::Representation + + property :comment, as: 'comment' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + collection :creative_group_ids, as: 'creativeGroupIds' + property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_7::DefaultClickThroughEventTagProperties::Representation + + property :end_date, as: 'endDate', type: Date + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_7::EventTagOverride, decorator: Google::Apis::DfareportingV2_7::EventTagOverride::Representation + + property :external_id, as: 'externalId' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_7::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_7::LookbackConfiguration::Representation + + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, as: 'subaccountId' + collection :trafficker_emails, as: 'traffickerEmails' + end + end + + class CampaignCreativeAssociation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_id, as: 'creativeId' + property :kind, as: 'kind' + end + end + + class CampaignCreativeAssociationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaign_creative_associations, as: 'campaignCreativeAssociations', class: Google::Apis::DfareportingV2_7::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV2_7::CampaignCreativeAssociation::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CampaignsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaigns, as: 'campaigns', class: Google::Apis::DfareportingV2_7::Campaign, decorator: Google::Apis::DfareportingV2_7::Campaign::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ChangeLog + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :action, as: 'action' + property :change_time, as: 'changeTime', type: DateTime + + property :field_name, as: 'fieldName' + property :id, as: 'id' + property :kind, as: 'kind' + property :new_value, as: 'newValue' + property :object_id_prop, as: 'objectId' + property :object_type, as: 'objectType' + property :old_value, as: 'oldValue' + property :subaccount_id, as: 'subaccountId' + property :transaction_id, as: 'transactionId' + property :user_profile_id, as: 'userProfileId' + property :user_profile_name, as: 'userProfileName' + end + end + + class ChangeLogsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :change_logs, as: 'changeLogs', class: Google::Apis::DfareportingV2_7::ChangeLog, decorator: Google::Apis::DfareportingV2_7::ChangeLog::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CitiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cities, as: 'cities', class: Google::Apis::DfareportingV2_7::City, decorator: Google::Apis::DfareportingV2_7::City::Representation + + property :kind, as: 'kind' + end + end + + class City + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, as: 'countryDartId' + property :dart_id, as: 'dartId' + property :kind, as: 'kind' + property :metro_code, as: 'metroCode' + property :metro_dma_id, as: 'metroDmaId' + property :name, as: 'name' + property :region_code, as: 'regionCode' + property :region_dart_id, as: 'regionDartId' + end + end + + class ClickTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :event_name, as: 'eventName' + property :name, as: 'name' + property :value, as: 'value' + end + end + + class ClickThroughUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :computed_click_through_url, as: 'computedClickThroughUrl' + property :custom_click_through_url, as: 'customClickThroughUrl' + property :default_landing_page, as: 'defaultLandingPage' + property :landing_page_id, as: 'landingPageId' + end + end + + class ClickThroughUrlSuffixProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url_suffix, as: 'clickThroughUrlSuffix' + property :override_inherited_suffix, as: 'overrideInheritedSuffix' + end + end + + class CompanionClickThroughOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_7::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrl::Representation + + property :creative_id, as: 'creativeId' + end + end + + class CompanionSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companions_disabled, as: 'companionsDisabled' + collection :enabled_sizes, as: 'enabledSizes', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :image_only, as: 'imageOnly' + property :kind, as: 'kind' + end + end + + class CompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cross_dimension_reach_report_compatible_fields, as: 'crossDimensionReachReportCompatibleFields', class: Google::Apis::DfareportingV2_7::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_7::CrossDimensionReachReportCompatibleFields::Representation + + property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV2_7::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV2_7::FloodlightReportCompatibleFields::Representation + + property :kind, as: 'kind' + property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV2_7::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV2_7::PathToConversionReportCompatibleFields::Representation + + property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV2_7::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_7::ReachReportCompatibleFields::Representation + + property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV2_7::ReportCompatibleFields, decorator: Google::Apis::DfareportingV2_7::ReportCompatibleFields::Representation + + end + end + + class ConnectionType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class ConnectionTypesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV2_7::ConnectionType, decorator: Google::Apis::DfareportingV2_7::ConnectionType::Representation + + property :kind, as: 'kind' + end + end + + class ContentCategoriesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :content_categories, as: 'contentCategories', class: Google::Apis::DfareportingV2_7::ContentCategory, decorator: Google::Apis::DfareportingV2_7::ContentCategory::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ContentCategory + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class Conversion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :child_directed_treatment, as: 'childDirectedTreatment' + collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV2_7::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV2_7::CustomFloodlightVariable::Representation + + property :encrypted_user_id, as: 'encryptedUserId' + collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' + property :floodlight_activity_id, as: 'floodlightActivityId' + property :floodlight_configuration_id, as: 'floodlightConfigurationId' + property :kind, as: 'kind' + property :limit_ad_tracking, as: 'limitAdTracking' + property :mobile_device_id, as: 'mobileDeviceId' + property :ordinal, as: 'ordinal' + property :quantity, as: 'quantity' + property :timestamp_micros, as: 'timestampMicros' + property :value, as: 'value' + end + end + + class ConversionError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :kind, as: 'kind' + property :message, as: 'message' + end + end + + class ConversionStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :conversion, as: 'conversion', class: Google::Apis::DfareportingV2_7::Conversion, decorator: Google::Apis::DfareportingV2_7::Conversion::Representation + + collection :errors, as: 'errors', class: Google::Apis::DfareportingV2_7::ConversionError, decorator: Google::Apis::DfareportingV2_7::ConversionError::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchInsertRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV2_7::Conversion, decorator: Google::Apis::DfareportingV2_7::Conversion::Representation + + property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV2_7::EncryptionInfo, decorator: Google::Apis::DfareportingV2_7::EncryptionInfo::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchInsertResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_failures, as: 'hasFailures' + property :kind, as: 'kind' + collection :status, as: 'status', class: Google::Apis::DfareportingV2_7::ConversionStatus, decorator: Google::Apis::DfareportingV2_7::ConversionStatus::Representation + + end + end + + class CountriesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_7::Country, decorator: Google::Apis::DfareportingV2_7::Country::Representation + + property :kind, as: 'kind' + end + end + + class Country + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :dart_id, as: 'dartId' + property :kind, as: 'kind' + property :name, as: 'name' + property :ssl_enabled, as: 'sslEnabled' + end + end + + class Creative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active, as: 'active' + property :ad_parameters, as: 'adParameters' + collection :ad_tag_keys, as: 'adTagKeys' + property :advertiser_id, as: 'advertiserId' + property :allow_script_access, as: 'allowScriptAccess' + property :archived, as: 'archived' + property :artwork_type, as: 'artworkType' + property :authoring_source, as: 'authoringSource' + property :authoring_tool, as: 'authoringTool' + property :auto_advance_images, as: 'auto_advance_images' + property :background_color, as: 'backgroundColor' + property :backup_image_click_through_url, as: 'backupImageClickThroughUrl' + collection :backup_image_features, as: 'backupImageFeatures' + property :backup_image_reporting_label, as: 'backupImageReportingLabel' + property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV2_7::TargetWindow, decorator: Google::Apis::DfareportingV2_7::TargetWindow::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_7::ClickTag, decorator: Google::Apis::DfareportingV2_7::ClickTag::Representation + + property :commercial_id, as: 'commercialId' + collection :companion_creatives, as: 'companionCreatives' + collection :compatibility, as: 'compatibility' + property :convert_flash_to_html5, as: 'convertFlashToHtml5' + collection :counter_custom_events, as: 'counterCustomEvents', class: Google::Apis::DfareportingV2_7::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_7::CreativeCustomEvent::Representation + + property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV2_7::CreativeAssetSelection, decorator: Google::Apis::DfareportingV2_7::CreativeAssetSelection::Representation + + collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV2_7::CreativeAsset, decorator: Google::Apis::DfareportingV2_7::CreativeAsset::Representation + + collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV2_7::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV2_7::CreativeFieldAssignment::Representation + + collection :custom_key_values, as: 'customKeyValues' + property :dynamic_asset_selection, as: 'dynamicAssetSelection' + collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV2_7::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_7::CreativeCustomEvent::Representation + + property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV2_7::FsCommand, decorator: Google::Apis::DfareportingV2_7::FsCommand::Representation + + property :html_code, as: 'htmlCode' + property :html_code_locked, as: 'htmlCodeLocked' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :latest_trafficked_creative_id, as: 'latestTraffickedCreativeId' + property :name, as: 'name' + property :override_css, as: 'overrideCss' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV2_7::VideoOffset, decorator: Google::Apis::DfareportingV2_7::VideoOffset::Representation + + property :redirect_url, as: 'redirectUrl' + property :rendering_id, as: 'renderingId' + property :rendering_id_dimension_value, as: 'renderingIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' + property :required_flash_version, as: 'requiredFlashVersion' + property :size, as: 'size', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_7::VideoOffset, decorator: Google::Apis::DfareportingV2_7::VideoOffset::Representation + + property :skippable, as: 'skippable' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_override, as: 'sslOverride' + property :studio_advertiser_id, as: 'studioAdvertiserId' + property :studio_creative_id, as: 'studioCreativeId' + property :studio_trafficked_creative_id, as: 'studioTraffickedCreativeId' + property :subaccount_id, as: 'subaccountId' + property :third_party_backup_image_impressions_url, as: 'thirdPartyBackupImageImpressionsUrl' + property :third_party_rich_media_impressions_url, as: 'thirdPartyRichMediaImpressionsUrl' + collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DfareportingV2_7::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV2_7::ThirdPartyTrackingUrl::Representation + + collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV2_7::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_7::CreativeCustomEvent::Representation + + property :total_file_size, as: 'totalFileSize' + property :type, as: 'type' + property :version, as: 'version' + property :video_description, as: 'videoDescription' + property :video_duration, as: 'videoDuration' + end + end + + class CreativeAsset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action_script3, as: 'actionScript3' + property :active, as: 'active' + property :alignment, as: 'alignment' + property :artwork_type, as: 'artworkType' + property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV2_7::CreativeAssetId, decorator: Google::Apis::DfareportingV2_7::CreativeAssetId::Representation + + property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV2_7::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_7::CreativeCustomEvent::Representation + + property :bit_rate, as: 'bitRate' + property :child_asset_type, as: 'childAssetType' + property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + collection :companion_creative_ids, as: 'companionCreativeIds' + property :custom_start_time_value, as: 'customStartTimeValue' + collection :detected_features, as: 'detectedFeatures' + property :display_type, as: 'displayType' + property :duration, as: 'duration' + property :duration_type, as: 'durationType' + property :expanded_dimension, as: 'expandedDimension', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :file_size, as: 'fileSize' + property :flash_version, as: 'flashVersion' + property :hide_flash_objects, as: 'hideFlashObjects' + property :hide_selection_boxes, as: 'hideSelectionBoxes' + property :horizontally_locked, as: 'horizontallyLocked' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :mime_type, as: 'mimeType' + property :offset, as: 'offset', class: Google::Apis::DfareportingV2_7::OffsetPosition, decorator: Google::Apis::DfareportingV2_7::OffsetPosition::Representation + + property :original_backup, as: 'originalBackup' + property :position, as: 'position', class: Google::Apis::DfareportingV2_7::OffsetPosition, decorator: Google::Apis::DfareportingV2_7::OffsetPosition::Representation + + property :position_left_unit, as: 'positionLeftUnit' + property :position_top_unit, as: 'positionTopUnit' + property :progressive_serving_url, as: 'progressiveServingUrl' + property :pushdown, as: 'pushdown' + property :pushdown_duration, as: 'pushdownDuration' + property :role, as: 'role' + property :size, as: 'size', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :ssl_compliant, as: 'sslCompliant' + property :start_time_type, as: 'startTimeType' + property :streaming_serving_url, as: 'streamingServingUrl' + property :transparency, as: 'transparency' + property :vertically_locked, as: 'verticallyLocked' + property :video_duration, as: 'videoDuration' + property :window_mode, as: 'windowMode' + property :z_index, as: 'zIndex' + property :zip_filename, as: 'zipFilename' + property :zip_filesize, as: 'zipFilesize' + end + end + + class CreativeAssetId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :type, as: 'type' + end + end + + class CreativeAssetMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV2_7::CreativeAssetId, decorator: Google::Apis::DfareportingV2_7::CreativeAssetId::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_7::ClickTag, decorator: Google::Apis::DfareportingV2_7::ClickTag::Representation + + collection :detected_features, as: 'detectedFeatures' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + collection :warned_validation_rules, as: 'warnedValidationRules' + end + end + + class CreativeAssetSelection + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_asset_id, as: 'defaultAssetId' + collection :rules, as: 'rules', class: Google::Apis::DfareportingV2_7::Rule, decorator: Google::Apis::DfareportingV2_7::Rule::Representation + + end + end + + class CreativeAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :apply_event_tags, as: 'applyEventTags' + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_7::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrl::Representation + + collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV2_7::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV2_7::CompanionClickThroughOverride::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_7::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_7::CreativeGroupAssignment::Representation + + property :creative_id, as: 'creativeId' + property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :end_time, as: 'endTime', type: DateTime + + collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV2_7::RichMediaExitOverride, decorator: Google::Apis::DfareportingV2_7::RichMediaExitOverride::Representation + + property :sequence, as: 'sequence' + property :ssl_compliant, as: 'sslCompliant' + property :start_time, as: 'startTime', type: DateTime + + property :weight, as: 'weight' + end + end + + class CreativeCustomEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_custom_event_id, as: 'advertiserCustomEventId' + property :advertiser_custom_event_name, as: 'advertiserCustomEventName' + property :advertiser_custom_event_type, as: 'advertiserCustomEventType' + property :artwork_label, as: 'artworkLabel' + property :artwork_type, as: 'artworkType' + property :exit_url, as: 'exitUrl' + property :id, as: 'id' + property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV2_7::PopupWindowProperties, decorator: Google::Apis::DfareportingV2_7::PopupWindowProperties::Representation + + property :target_type, as: 'targetType' + property :video_reporting_id, as: 'videoReportingId' + end + end + + class CreativeField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + end + end + + class CreativeFieldAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_field_id, as: 'creativeFieldId' + property :creative_field_value_id, as: 'creativeFieldValueId' + end + end + + class CreativeFieldValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :value, as: 'value' + end + end + + class CreativeFieldValuesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_field_values, as: 'creativeFieldValues', class: Google::Apis::DfareportingV2_7::CreativeFieldValue, decorator: Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeFieldsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_fields, as: 'creativeFields', class: Google::Apis::DfareportingV2_7::CreativeField, decorator: Google::Apis::DfareportingV2_7::CreativeField::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :group_number, as: 'groupNumber' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + end + end + + class CreativeGroupAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_group_id, as: 'creativeGroupId' + property :creative_group_number, as: 'creativeGroupNumber' + end + end + + class CreativeGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_groups, as: 'creativeGroups', class: Google::Apis::DfareportingV2_7::CreativeGroup, decorator: Google::Apis::DfareportingV2_7::CreativeGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeOptimizationConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :name, as: 'name' + collection :optimization_activitys, as: 'optimizationActivitys', class: Google::Apis::DfareportingV2_7::OptimizationActivity, decorator: Google::Apis::DfareportingV2_7::OptimizationActivity::Representation + + property :optimization_model, as: 'optimizationModel' + end + end + + class CreativeRotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_assignments, as: 'creativeAssignments', class: Google::Apis::DfareportingV2_7::CreativeAssignment, decorator: Google::Apis::DfareportingV2_7::CreativeAssignment::Representation + + property :creative_optimization_configuration_id, as: 'creativeOptimizationConfigurationId' + property :type, as: 'type' + property :weight_calculation_strategy, as: 'weightCalculationStrategy' + end + end + + class CreativeSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :i_frame_footer, as: 'iFrameFooter' + property :i_frame_header, as: 'iFrameHeader' + end + end + + class CreativesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creatives, as: 'creatives', class: Google::Apis::DfareportingV2_7::Creative, decorator: Google::Apis::DfareportingV2_7::Creative::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CrossDimensionReachReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + end + end + + class CustomFloodlightVariable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :type, as: 'type' + property :value, as: 'value' + end + end + + class CustomRichMediaEvents + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :filtered_event_ids, as: 'filteredEventIds', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + end + end + + class DateRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :kind, as: 'kind' + property :relative_date_range, as: 'relativeDateRange' + property :start_date, as: 'startDate', type: Date + + end + end + + class DayPartTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :days_of_week, as: 'daysOfWeek' + collection :hours_of_day, as: 'hoursOfDay' + property :user_local_time, as: 'userLocalTime' + end + end + + class DefaultClickThroughEventTagProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_click_through_event_tag_id, as: 'defaultClickThroughEventTagId' + property :override_inherited_event_tag, as: 'overrideInheritedEventTag' + end + end + + class DeliverySchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DfareportingV2_7::FrequencyCap, decorator: Google::Apis::DfareportingV2_7::FrequencyCap::Representation + + property :hard_cutoff, as: 'hardCutoff' + property :impression_ratio, as: 'impressionRatio' + property :priority, as: 'priority' + end + end + + class DfpSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dfp_network_code, as: 'dfp_network_code' + property :dfp_network_name, as: 'dfp_network_name' + property :programmatic_placement_accepted, as: 'programmaticPlacementAccepted' + property :pub_paid_placement_accepted, as: 'pubPaidPlacementAccepted' + property :publisher_portal_only, as: 'publisherPortalOnly' + end + end + + class Dimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class DimensionFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :kind, as: 'kind' + property :value, as: 'value' + end + end + + class DimensionValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :etag, as: 'etag' + property :id, as: 'id' + property :kind, as: 'kind' + property :match_type, as: 'matchType' + property :value, as: 'value' + end + end + + class DimensionValueList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DimensionValueRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :end_date, as: 'endDate', type: Date + + collection :filters, as: 'filters', class: Google::Apis::DfareportingV2_7::DimensionFilter, decorator: Google::Apis::DfareportingV2_7::DimensionFilter::Representation + + property :kind, as: 'kind' + property :start_date, as: 'startDate', type: Date + + end + end + + class DirectorySite + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + collection :contact_assignments, as: 'contactAssignments', class: Google::Apis::DfareportingV2_7::DirectorySiteContactAssignment, decorator: Google::Apis::DfareportingV2_7::DirectorySiteContactAssignment::Representation + + property :country_id, as: 'countryId' + property :currency_id, as: 'currencyId' + property :description, as: 'description' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :inpage_tag_formats, as: 'inpageTagFormats' + collection :interstitial_tag_formats, as: 'interstitialTagFormats' + property :kind, as: 'kind' + property :name, as: 'name' + property :parent_id, as: 'parentId' + property :settings, as: 'settings', class: Google::Apis::DfareportingV2_7::DirectorySiteSettings, decorator: Google::Apis::DfareportingV2_7::DirectorySiteSettings::Representation + + property :url, as: 'url' + end + end + + class DirectorySiteContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :email, as: 'email' + property :first_name, as: 'firstName' + property :id, as: 'id' + property :kind, as: 'kind' + property :last_name, as: 'lastName' + property :phone, as: 'phone' + property :role, as: 'role' + property :title, as: 'title' + property :type, as: 'type' + end + end + + class DirectorySiteContactAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contact_id, as: 'contactId' + property :visibility, as: 'visibility' + end + end + + class DirectorySiteContactsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :directory_site_contacts, as: 'directorySiteContacts', class: Google::Apis::DfareportingV2_7::DirectorySiteContact, decorator: Google::Apis::DfareportingV2_7::DirectorySiteContact::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DirectorySiteSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_opt_out, as: 'activeViewOptOut' + property :dfp_settings, as: 'dfp_settings', class: Google::Apis::DfareportingV2_7::DfpSettings, decorator: Google::Apis::DfareportingV2_7::DfpSettings::Representation + + property :instream_video_placement_accepted, as: 'instream_video_placement_accepted' + property :interstitial_placement_accepted, as: 'interstitialPlacementAccepted' + property :nielsen_ocr_opt_out, as: 'nielsenOcrOptOut' + property :verification_tag_opt_out, as: 'verificationTagOptOut' + property :video_active_view_opt_out, as: 'videoActiveViewOptOut' + end + end + + class DirectorySitesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :directory_sites, as: 'directorySites', class: Google::Apis::DfareportingV2_7::DirectorySite, decorator: Google::Apis::DfareportingV2_7::DirectorySite::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DynamicTargetingKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + property :object_id_prop, as: 'objectId' + property :object_type, as: 'objectType' + end + end + + class DynamicTargetingKeysListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dynamic_targeting_keys, as: 'dynamicTargetingKeys', class: Google::Apis::DfareportingV2_7::DynamicTargetingKey, decorator: Google::Apis::DfareportingV2_7::DynamicTargetingKey::Representation + + property :kind, as: 'kind' + end + end + + class EncryptionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :encryption_entity_id, as: 'encryptionEntityId' + property :encryption_entity_type, as: 'encryptionEntityType' + property :encryption_source, as: 'encryptionSource' + property :kind, as: 'kind' + end + end + + class EventTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :campaign_id, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :enabled_by_default, as: 'enabledByDefault' + property :exclude_from_adx_requests, as: 'excludeFromAdxRequests' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :site_filter_type, as: 'siteFilterType' + collection :site_ids, as: 'siteIds' + property :ssl_compliant, as: 'sslCompliant' + property :status, as: 'status' + property :subaccount_id, as: 'subaccountId' + property :type, as: 'type' + property :url, as: 'url' + property :url_escape_levels, as: 'urlEscapeLevels' + end + end + + class EventTagOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + property :id, as: 'id' + end + end + + class EventTagsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :event_tags, as: 'eventTags', class: Google::Apis::DfareportingV2_7::EventTag, decorator: Google::Apis::DfareportingV2_7::EventTag::Representation + + property :kind, as: 'kind' + end + end + + class File + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :format, as: 'format' + property :id, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, as: 'lastModifiedTime' + property :report_id, as: 'reportId' + property :status, as: 'status' + property :urls, as: 'urls', class: Google::Apis::DfareportingV2_7::File::Urls, decorator: Google::Apis::DfareportingV2_7::File::Urls::Representation + + end + + class Urls + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_url, as: 'apiUrl' + property :browser_url, as: 'browserUrl' + end + end + end + + class FileList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV2_7::File, decorator: Google::Apis::DfareportingV2_7::File::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Flight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :rate_or_cost, as: 'rateOrCost' + property :start_date, as: 'startDate', type: Date + + property :units, as: 'units' + end + end + + class FloodlightActivitiesGenerateTagResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_tag, as: 'floodlightActivityTag' + property :kind, as: 'kind' + end + end + + class FloodlightActivitiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV2_7::FloodlightActivity, decorator: Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class FloodlightActivity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :cache_busting_type, as: 'cacheBustingType' + property :counting_method, as: 'countingMethod' + collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV2_7::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_7::FloodlightActivityDynamicTag::Representation + + property :expected_url, as: 'expectedUrl' + property :floodlight_activity_group_id, as: 'floodlightActivityGroupId' + property :floodlight_activity_group_name, as: 'floodlightActivityGroupName' + property :floodlight_activity_group_tag_string, as: 'floodlightActivityGroupTagString' + property :floodlight_activity_group_type, as: 'floodlightActivityGroupType' + property :floodlight_configuration_id, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :hidden, as: 'hidden' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :image_tag_enabled, as: 'imageTagEnabled' + property :kind, as: 'kind' + property :name, as: 'name' + property :notes, as: 'notes' + collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV2_7::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV2_7::FloodlightActivityPublisherDynamicTag::Representation + + property :secure, as: 'secure' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :subaccount_id, as: 'subaccountId' + property :tag_format, as: 'tagFormat' + property :tag_string, as: 'tagString' + collection :user_defined_variable_types, as: 'userDefinedVariableTypes' + end + end + + class FloodlightActivityDynamicTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :name, as: 'name' + property :tag, as: 'tag' + end + end + + class FloodlightActivityGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :floodlight_configuration_id, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + property :tag_string, as: 'tagString' + property :type, as: 'type' + end + end + + class FloodlightActivityGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activity_groups, as: 'floodlightActivityGroups', class: Google::Apis::DfareportingV2_7::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class FloodlightActivityPublisherDynamicTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through, as: 'clickThrough' + property :directory_site_id, as: 'directorySiteId' + property :dynamic_tag, as: 'dynamicTag', class: Google::Apis::DfareportingV2_7::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_7::FloodlightActivityDynamicTag::Representation + + property :site_id, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :view_through, as: 'viewThrough' + end + end + + class FloodlightConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :analytics_data_sharing_enabled, as: 'analyticsDataSharingEnabled' + property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' + property :first_day_of_week, as: 'firstDayOfWeek' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' + property :kind, as: 'kind' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_7::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_7::LookbackConfiguration::Representation + + property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' + property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV2_7::OmnitureSettings, decorator: Google::Apis::DfareportingV2_7::OmnitureSettings::Representation + + collection :standard_variable_types, as: 'standardVariableTypes' + property :subaccount_id, as: 'subaccountId' + property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV2_7::TagSettings, decorator: Google::Apis::DfareportingV2_7::TagSettings::Representation + + collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV2_7::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV2_7::ThirdPartyAuthenticationToken::Representation + + collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV2_7::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV2_7::UserDefinedVariableConfiguration::Representation + + end + end + + class FloodlightConfigurationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV2_7::FloodlightConfiguration, decorator: Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + + property :kind, as: 'kind' + end + end + + class FloodlightReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + end + end + + class FrequencyCap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, as: 'duration' + property :impressions, as: 'impressions' + end + end + + class FsCommand + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :left, as: 'left' + property :position_option, as: 'positionOption' + property :top, as: 'top' + property :window_height, as: 'windowHeight' + property :window_width, as: 'windowWidth' + end + end + + class GeoTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cities, as: 'cities', class: Google::Apis::DfareportingV2_7::City, decorator: Google::Apis::DfareportingV2_7::City::Representation + + collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_7::Country, decorator: Google::Apis::DfareportingV2_7::Country::Representation + + property :exclude_countries, as: 'excludeCountries' + collection :metros, as: 'metros', class: Google::Apis::DfareportingV2_7::Metro, decorator: Google::Apis::DfareportingV2_7::Metro::Representation + + collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV2_7::PostalCode, decorator: Google::Apis::DfareportingV2_7::PostalCode::Representation + + collection :regions, as: 'regions', class: Google::Apis::DfareportingV2_7::Region, decorator: Google::Apis::DfareportingV2_7::Region::Representation + + end + end + + class InventoryItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + collection :ad_slots, as: 'adSlots', class: Google::Apis::DfareportingV2_7::AdSlot, decorator: Google::Apis::DfareportingV2_7::AdSlot::Representation + + property :advertiser_id, as: 'advertiserId' + property :content_category_id, as: 'contentCategoryId' + property :estimated_click_through_rate, as: 'estimatedClickThroughRate' + property :estimated_conversion_rate, as: 'estimatedConversionRate' + property :id, as: 'id' + property :in_plan, as: 'inPlan' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :name, as: 'name' + property :negotiation_channel_id, as: 'negotiationChannelId' + property :order_id, as: 'orderId' + property :placement_strategy_id, as: 'placementStrategyId' + property :pricing, as: 'pricing', class: Google::Apis::DfareportingV2_7::Pricing, decorator: Google::Apis::DfareportingV2_7::Pricing::Representation + + property :project_id, as: 'projectId' + property :rfp_id, as: 'rfpId' + property :site_id, as: 'siteId' + property :subaccount_id, as: 'subaccountId' + property :type, as: 'type' + end + end + + class InventoryItemsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :inventory_items, as: 'inventoryItems', class: Google::Apis::DfareportingV2_7::InventoryItem, decorator: Google::Apis::DfareportingV2_7::InventoryItem::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class KeyValueTargetingExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expression, as: 'expression' + end + end + + class LandingPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default, as: 'default' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :url, as: 'url' + end + end + + class LandingPagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV2_7::LandingPage, decorator: Google::Apis::DfareportingV2_7::LandingPage::Representation + + end + end + + class Language + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :language_code, as: 'languageCode' + property :name, as: 'name' + end + end + + class LanguageTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :languages, as: 'languages', class: Google::Apis::DfareportingV2_7::Language, decorator: Google::Apis::DfareportingV2_7::Language::Representation + + end + end + + class LanguagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :languages, as: 'languages', class: Google::Apis::DfareportingV2_7::Language, decorator: Google::Apis::DfareportingV2_7::Language::Representation + + end + end + + class LastModifiedInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :time, as: 'time' + end + end + + class ListPopulationClause + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :terms, as: 'terms', class: Google::Apis::DfareportingV2_7::ListPopulationTerm, decorator: Google::Apis::DfareportingV2_7::ListPopulationTerm::Representation + + end + end + + class ListPopulationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, as: 'floodlightActivityId' + property :floodlight_activity_name, as: 'floodlightActivityName' + collection :list_population_clauses, as: 'listPopulationClauses', class: Google::Apis::DfareportingV2_7::ListPopulationClause, decorator: Google::Apis::DfareportingV2_7::ListPopulationClause::Representation + + end + end + + class ListPopulationTerm + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contains, as: 'contains' + property :negation, as: 'negation' + property :operator, as: 'operator' + property :remarketing_list_id, as: 'remarketingListId' + property :type, as: 'type' + property :value, as: 'value' + property :variable_friendly_name, as: 'variableFriendlyName' + property :variable_name, as: 'variableName' + end + end + + class ListTargetingExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expression, as: 'expression' + end + end + + class LookbackConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_duration, as: 'clickDuration' + property :post_impression_activities_duration, as: 'postImpressionActivitiesDuration' + end + end + + class Metric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class Metro + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, as: 'countryDartId' + property :dart_id, as: 'dartId' + property :dma_id, as: 'dmaId' + property :kind, as: 'kind' + property :metro_code, as: 'metroCode' + property :name, as: 'name' + end + end + + class MetrosListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :metros, as: 'metros', class: Google::Apis::DfareportingV2_7::Metro, decorator: Google::Apis::DfareportingV2_7::Metro::Representation + + end + end + + class MobileCarrier + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, as: 'countryDartId' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class MobileCarriersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV2_7::MobileCarrier, decorator: Google::Apis::DfareportingV2_7::MobileCarrier::Representation + + end + end + + class ObjectFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :object_ids, as: 'objectIds' + property :status, as: 'status' + end + end + + class OffsetPosition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :left, as: 'left' + property :top, as: 'top' + end + end + + class OmnitureSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :omniture_cost_data_enabled, as: 'omnitureCostDataEnabled' + property :omniture_integration_enabled, as: 'omnitureIntegrationEnabled' + end + end + + class OperatingSystem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dart_id, as: 'dartId' + property :desktop, as: 'desktop' + property :kind, as: 'kind' + property :mobile, as: 'mobile' + property :name, as: 'name' + end + end + + class OperatingSystemVersion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :major_version, as: 'majorVersion' + property :minor_version, as: 'minorVersion' + property :name, as: 'name' + property :operating_system, as: 'operatingSystem', class: Google::Apis::DfareportingV2_7::OperatingSystem, decorator: Google::Apis::DfareportingV2_7::OperatingSystem::Representation + + end + end + + class OperatingSystemVersionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV2_7::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_7::OperatingSystemVersion::Representation + + end + end + + class OperatingSystemsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV2_7::OperatingSystem, decorator: Google::Apis::DfareportingV2_7::OperatingSystem::Representation + + end + end + + class OptimizationActivity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, as: 'floodlightActivityId' + property :floodlight_activity_id_dimension_value, as: 'floodlightActivityIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :weight, as: 'weight' + end + end + + class Order + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + collection :approver_user_profile_ids, as: 'approverUserProfileIds' + property :buyer_invoice_id, as: 'buyerInvoiceId' + property :buyer_organization_name, as: 'buyerOrganizationName' + property :comments, as: 'comments' + collection :contacts, as: 'contacts', class: Google::Apis::DfareportingV2_7::OrderContact, decorator: Google::Apis::DfareportingV2_7::OrderContact::Representation + + property :id, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :name, as: 'name' + property :notes, as: 'notes' + property :planning_term_id, as: 'planningTermId' + property :project_id, as: 'projectId' + property :seller_order_id, as: 'sellerOrderId' + property :seller_organization_name, as: 'sellerOrganizationName' + collection :site_id, as: 'siteId' + collection :site_names, as: 'siteNames' + property :subaccount_id, as: 'subaccountId' + property :terms_and_conditions, as: 'termsAndConditions' + end + end + + class OrderContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contact_info, as: 'contactInfo' + property :contact_name, as: 'contactName' + property :contact_title, as: 'contactTitle' + property :contact_type, as: 'contactType' + property :signature_user_profile_id, as: 'signatureUserProfileId' + end + end + + class OrderDocument + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :amended_order_document_id, as: 'amendedOrderDocumentId' + collection :approved_by_user_profile_ids, as: 'approvedByUserProfileIds' + property :cancelled, as: 'cancelled' + property :created_info, as: 'createdInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :effective_date, as: 'effectiveDate', type: Date + + property :id, as: 'id' + property :kind, as: 'kind' + collection :last_sent_recipients, as: 'lastSentRecipients' + property :last_sent_time, as: 'lastSentTime', type: DateTime + + property :order_id, as: 'orderId' + property :project_id, as: 'projectId' + property :signed, as: 'signed' + property :subaccount_id, as: 'subaccountId' + property :title, as: 'title' + property :type, as: 'type' + end + end + + class OrderDocumentsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :order_documents, as: 'orderDocuments', class: Google::Apis::DfareportingV2_7::OrderDocument, decorator: Google::Apis::DfareportingV2_7::OrderDocument::Representation + + end + end + + class OrdersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :orders, as: 'orders', class: Google::Apis::DfareportingV2_7::Order, decorator: Google::Apis::DfareportingV2_7::Order::Representation + + end + end + + class PathToConversionReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + end + end + + class Placement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :content_category_id, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :directory_site_id, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_7::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_7::LookbackConfiguration::Representation + + property :name, as: 'name' + property :payment_approved, as: 'paymentApproved' + property :payment_source, as: 'paymentSource' + property :placement_group_id, as: 'placementGroupId' + property :placement_group_id_dimension_value, as: 'placementGroupIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :placement_strategy_id, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV2_7::PricingSchedule, decorator: Google::Apis::DfareportingV2_7::PricingSchedule::Representation + + property :primary, as: 'primary' + property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :site_id, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :ssl_required, as: 'sslRequired' + property :status, as: 'status' + property :subaccount_id, as: 'subaccountId' + collection :tag_formats, as: 'tagFormats' + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV2_7::TagSetting, decorator: Google::Apis::DfareportingV2_7::TagSetting::Representation + + property :video_active_view_opt_out, as: 'videoActiveViewOptOut' + property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV2_7::VideoSettings, decorator: Google::Apis::DfareportingV2_7::VideoSettings::Representation + + property :vpaid_adapter_choice, as: 'vpaidAdapterChoice' + end + end + + class PlacementAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :placement_id, as: 'placementId' + property :placement_id_dimension_value, as: 'placementIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :ssl_required, as: 'sslRequired' + end + end + + class PlacementGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :child_placement_ids, as: 'childPlacementIds' + property :comment, as: 'comment' + property :content_category_id, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :directory_site_id, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :name, as: 'name' + property :placement_group_type, as: 'placementGroupType' + property :placement_strategy_id, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV2_7::PricingSchedule, decorator: Google::Apis::DfareportingV2_7::PricingSchedule::Representation + + property :primary_placement_id, as: 'primaryPlacementId' + property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :site_id, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :subaccount_id, as: 'subaccountId' + end + end + + class PlacementGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placement_groups, as: 'placementGroups', class: Google::Apis::DfareportingV2_7::PlacementGroup, decorator: Google::Apis::DfareportingV2_7::PlacementGroup::Representation + + end + end + + class PlacementStrategiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placement_strategies, as: 'placementStrategies', class: Google::Apis::DfareportingV2_7::PlacementStrategy, decorator: Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + + end + end + + class PlacementStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class PlacementTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :placement_id, as: 'placementId' + collection :tag_datas, as: 'tagDatas', class: Google::Apis::DfareportingV2_7::TagData, decorator: Google::Apis::DfareportingV2_7::TagData::Representation + + end + end + + class PlacementsGenerateTagsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :placement_tags, as: 'placementTags', class: Google::Apis::DfareportingV2_7::PlacementTag, decorator: Google::Apis::DfareportingV2_7::PlacementTag::Representation + + end + end + + class PlacementsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placements, as: 'placements', class: Google::Apis::DfareportingV2_7::Placement, decorator: Google::Apis::DfareportingV2_7::Placement::Representation + + end + end + + class PlatformType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class PlatformTypesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV2_7::PlatformType, decorator: Google::Apis::DfareportingV2_7::PlatformType::Representation + + end + end + + class PopupWindowProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension, as: 'dimension', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :offset, as: 'offset', class: Google::Apis::DfareportingV2_7::OffsetPosition, decorator: Google::Apis::DfareportingV2_7::OffsetPosition::Representation + + property :position_type, as: 'positionType' + property :show_address_bar, as: 'showAddressBar' + property :show_menu_bar, as: 'showMenuBar' + property :show_scroll_bar, as: 'showScrollBar' + property :show_status_bar, as: 'showStatusBar' + property :show_tool_bar, as: 'showToolBar' + property :title, as: 'title' + end + end + + class PostalCode + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :country_code, as: 'countryCode' + property :country_dart_id, as: 'countryDartId' + property :id, as: 'id' + property :kind, as: 'kind' + end + end + + class PostalCodesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV2_7::PostalCode, decorator: Google::Apis::DfareportingV2_7::PostalCode::Representation + + end + end + + class Pricing + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cap_cost_type, as: 'capCostType' + property :end_date, as: 'endDate', type: Date + + collection :flights, as: 'flights', class: Google::Apis::DfareportingV2_7::Flight, decorator: Google::Apis::DfareportingV2_7::Flight::Representation + + property :group_type, as: 'groupType' + property :pricing_type, as: 'pricingType' + property :start_date, as: 'startDate', type: Date + + end + end + + class PricingSchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cap_cost_option, as: 'capCostOption' + property :disregard_overdelivery, as: 'disregardOverdelivery' + property :end_date, as: 'endDate', type: Date + + property :flighted, as: 'flighted' + property :floodlight_activity_id, as: 'floodlightActivityId' + collection :pricing_periods, as: 'pricingPeriods', class: Google::Apis::DfareportingV2_7::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV2_7::PricingSchedulePricingPeriod::Representation + + property :pricing_type, as: 'pricingType' + property :start_date, as: 'startDate', type: Date + + property :testing_start_date, as: 'testingStartDate', type: Date + + end + end + + class PricingSchedulePricingPeriod + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :pricing_comment, as: 'pricingComment' + property :rate_or_cost_nanos, as: 'rateOrCostNanos' + property :start_date, as: 'startDate', type: Date + + property :units, as: 'units' + end + end + + class Project + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :audience_age_group, as: 'audienceAgeGroup' + property :audience_gender, as: 'audienceGender' + property :budget, as: 'budget' + property :client_billing_code, as: 'clientBillingCode' + property :client_name, as: 'clientName' + property :end_date, as: 'endDate', type: Date + + property :id, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_7::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_7::LastModifiedInfo::Representation + + property :name, as: 'name' + property :overview, as: 'overview' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, as: 'subaccountId' + property :target_clicks, as: 'targetClicks' + property :target_conversions, as: 'targetConversions' + property :target_cpa_nanos, as: 'targetCpaNanos' + property :target_cpc_nanos, as: 'targetCpcNanos' + property :target_cpm_active_view_nanos, as: 'targetCpmActiveViewNanos' + property :target_cpm_nanos, as: 'targetCpmNanos' + property :target_impressions, as: 'targetImpressions' + end + end + + class ProjectsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :projects, as: 'projects', class: Google::Apis::DfareportingV2_7::Project, decorator: Google::Apis::DfareportingV2_7::Project::Representation + + end + end + + class ReachReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + end + end + + class Recipient + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :delivery_type, as: 'deliveryType' + property :email, as: 'email' + property :kind, as: 'kind' + end + end + + class Region + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, as: 'countryDartId' + property :dart_id, as: 'dartId' + property :kind, as: 'kind' + property :name, as: 'name' + property :region_code, as: 'regionCode' + end + end + + class RegionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :regions, as: 'regions', class: Google::Apis::DfareportingV2_7::Region, decorator: Google::Apis::DfareportingV2_7::Region::Representation + + end + end + + class RemarketingList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :description, as: 'description' + property :id, as: 'id' + property :kind, as: 'kind' + property :life_span, as: 'lifeSpan' + property :list_population_rule, as: 'listPopulationRule', class: Google::Apis::DfareportingV2_7::ListPopulationRule, decorator: Google::Apis::DfareportingV2_7::ListPopulationRule::Representation + + property :list_size, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + end + end + + class RemarketingListShare + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :remarketing_list_id, as: 'remarketingListId' + collection :shared_account_ids, as: 'sharedAccountIds' + collection :shared_advertiser_ids, as: 'sharedAdvertiserIds' + end + end + + class RemarketingListsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :remarketing_lists, as: 'remarketingLists', class: Google::Apis::DfareportingV2_7::RemarketingList, decorator: Google::Apis::DfareportingV2_7::RemarketingList::Representation + + end + end + + class Report + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :criteria, as: 'criteria', class: Google::Apis::DfareportingV2_7::Report::Criteria, decorator: Google::Apis::DfareportingV2_7::Report::Criteria::Representation + + property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV2_7::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV2_7::Report::CrossDimensionReachCriteria::Representation + + property :delivery, as: 'delivery', class: Google::Apis::DfareportingV2_7::Report::Delivery, decorator: Google::Apis::DfareportingV2_7::Report::Delivery::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV2_7::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV2_7::Report::FloodlightCriteria::Representation + + property :format, as: 'format' + property :id, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, as: 'lastModifiedTime' + property :name, as: 'name' + property :owner_profile_id, as: 'ownerProfileId' + property :path_to_conversion_criteria, as: 'pathToConversionCriteria', class: Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria::Representation + + property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV2_7::Report::ReachCriteria, decorator: Google::Apis::DfareportingV2_7::Report::ReachCriteria::Representation + + property :schedule, as: 'schedule', class: Google::Apis::DfareportingV2_7::Report::Schedule, decorator: Google::Apis::DfareportingV2_7::Report::Schedule::Representation + + property :sub_account_id, as: 'subAccountId' + property :type, as: 'type' + end + + class Criteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activities, as: 'activities', class: Google::Apis::DfareportingV2_7::Activities, decorator: Google::Apis::DfareportingV2_7::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_7::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_7::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + collection :metric_names, as: 'metricNames' + end + end + + class CrossDimensionReachCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + property :dimension, as: 'dimension' + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + collection :overlap_metric_names, as: 'overlapMetricNames' + property :pivoted, as: 'pivoted' + end + end + + class Delivery + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email_owner, as: 'emailOwner' + property :email_owner_delivery_type, as: 'emailOwnerDeliveryType' + property :message, as: 'message' + collection :recipients, as: 'recipients', class: Google::Apis::DfareportingV2_7::Recipient, decorator: Google::Apis::DfareportingV2_7::Recipient::Representation + + end + end + + class FloodlightCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_7::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_7::Report::FloodlightCriteria::ReportProperties::Representation + + end + + class ReportProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' + property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' + property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' + end + end + end + + class PathToConversionCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :activity_filters, as: 'activityFilters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_7::Report::PathToConversionCriteria::ReportProperties::Representation + + end + + class ReportProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :clicks_lookback_window, as: 'clicksLookbackWindow' + property :impressions_lookback_window, as: 'impressionsLookbackWindow' + property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' + property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' + property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' + property :maximum_click_interactions, as: 'maximumClickInteractions' + property :maximum_impression_interactions, as: 'maximumImpressionInteractions' + property :maximum_interaction_gap, as: 'maximumInteractionGap' + property :pivot_on_interaction_path, as: 'pivotOnInteractionPath' + end + end + end + + class ReachCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activities, as: 'activities', class: Google::Apis::DfareportingV2_7::Activities, decorator: Google::Apis::DfareportingV2_7::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_7::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_7::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_7::DateRange, decorator: Google::Apis::DfareportingV2_7::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::SortedDimension, decorator: Google::Apis::DfareportingV2_7::SortedDimension::Representation + + property :enable_all_dimension_combinations, as: 'enableAllDimensionCombinations' + collection :metric_names, as: 'metricNames' + collection :reach_by_frequency_metric_names, as: 'reachByFrequencyMetricNames' + end + end + + class Schedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :every, as: 'every' + property :expiration_date, as: 'expirationDate', type: Date + + property :repeats, as: 'repeats' + collection :repeats_on_week_days, as: 'repeatsOnWeekDays' + property :runs_on_day_of_month, as: 'runsOnDayOfMonth' + property :start_date, as: 'startDate', type: Date + + end + end + end + + class ReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_7::Dimension, decorator: Google::Apis::DfareportingV2_7::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_7::Metric, decorator: Google::Apis::DfareportingV2_7::Metric::Representation + + end + end + + class ReportList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV2_7::Report, decorator: Google::Apis::DfareportingV2_7::Report::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ReportsConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_7::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_7::LookbackConfiguration::Representation + + property :report_generation_time_zone_id, as: 'reportGenerationTimeZoneId' + end + end + + class RichMediaExitOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_7::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_7::ClickThroughUrl::Representation + + property :enabled, as: 'enabled' + property :exit_id, as: 'exitId' + end + end + + class Rule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset_id, as: 'assetId' + property :name, as: 'name' + property :targeting_template_id, as: 'targetingTemplateId' + end + end + + class Site + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :approved, as: 'approved' + property :directory_site_id, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :id, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :name, as: 'name' + collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV2_7::SiteContact, decorator: Google::Apis::DfareportingV2_7::SiteContact::Representation + + property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV2_7::SiteSettings, decorator: Google::Apis::DfareportingV2_7::SiteSettings::Representation + + property :subaccount_id, as: 'subaccountId' + end + end + + class SiteContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :contact_type, as: 'contactType' + property :email, as: 'email' + property :first_name, as: 'firstName' + property :id, as: 'id' + property :last_name, as: 'lastName' + property :phone, as: 'phone' + property :title, as: 'title' + end + end + + class SiteSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_opt_out, as: 'activeViewOptOut' + property :creative_settings, as: 'creativeSettings', class: Google::Apis::DfareportingV2_7::CreativeSettings, decorator: Google::Apis::DfareportingV2_7::CreativeSettings::Representation + + property :disable_brand_safe_ads, as: 'disableBrandSafeAds' + property :disable_new_cookie, as: 'disableNewCookie' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_7::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_7::LookbackConfiguration::Representation + + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV2_7::TagSetting, decorator: Google::Apis::DfareportingV2_7::TagSetting::Representation + + property :video_active_view_opt_out_template, as: 'videoActiveViewOptOutTemplate' + property :vpaid_adapter_choice_template, as: 'vpaidAdapterChoiceTemplate' + end + end + + class SitesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :sites, as: 'sites', class: Google::Apis::DfareportingV2_7::Site, decorator: Google::Apis::DfareportingV2_7::Site::Representation + + end + end + + class Size + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height, as: 'height' + property :iab, as: 'iab' + property :id, as: 'id' + property :kind, as: 'kind' + property :width, as: 'width' + end + end + + class SizesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :sizes, as: 'sizes', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + end + end + + class SkippableSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV2_7::VideoOffset, decorator: Google::Apis::DfareportingV2_7::VideoOffset::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_7::VideoOffset, decorator: Google::Apis::DfareportingV2_7::VideoOffset::Representation + + property :skippable, as: 'skippable' + end + end + + class SortedDimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + property :sort_order, as: 'sortOrder' + end + end + + class Subaccount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + collection :available_permission_ids, as: 'availablePermissionIds' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class SubaccountsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :subaccounts, as: 'subaccounts', class: Google::Apis::DfareportingV2_7::Subaccount, decorator: Google::Apis::DfareportingV2_7::Subaccount::Representation + + end + end + + class TagData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ad_id, as: 'adId' + property :click_tag, as: 'clickTag' + property :creative_id, as: 'creativeId' + property :format, as: 'format' + property :impression_tag, as: 'impressionTag' + end + end + + class TagSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :additional_key_values, as: 'additionalKeyValues' + property :include_click_through_urls, as: 'includeClickThroughUrls' + property :include_click_tracking, as: 'includeClickTracking' + property :keyword_option, as: 'keywordOption' + end + end + + class TagSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dynamic_tag_enabled, as: 'dynamicTagEnabled' + property :image_tag_enabled, as: 'imageTagEnabled' + end + end + + class TargetWindow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_html, as: 'customHtml' + property :target_window_option, as: 'targetWindowOption' + end + end + + class TargetableRemarketingList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :description, as: 'description' + property :id, as: 'id' + property :kind, as: 'kind' + property :life_span, as: 'lifeSpan' + property :list_size, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + end + end + + class TargetableRemarketingListsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :targetable_remarketing_lists, as: 'targetableRemarketingLists', class: Google::Apis::DfareportingV2_7::TargetableRemarketingList, decorator: Google::Apis::DfareportingV2_7::TargetableRemarketingList::Representation + + end + end + + class TargetingTemplate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :advertiser_id, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV2_7::DimensionValue, decorator: Google::Apis::DfareportingV2_7::DimensionValue::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_7::DayPartTargeting, decorator: Google::Apis::DfareportingV2_7::DayPartTargeting::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_7::GeoTargeting, decorator: Google::Apis::DfareportingV2_7::GeoTargeting::Representation + + property :id, as: 'id' + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_7::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_7::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_7::LanguageTargeting, decorator: Google::Apis::DfareportingV2_7::LanguageTargeting::Representation + + property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV2_7::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_7::ListTargetingExpression::Representation + + property :name, as: 'name' + property :subaccount_id, as: 'subaccountId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV2_7::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_7::TechnologyTargeting::Representation + + end + end + + class TargetingTemplatesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :targeting_templates, as: 'targetingTemplates', class: Google::Apis::DfareportingV2_7::TargetingTemplate, decorator: Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + + end + end + + class TechnologyTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV2_7::Browser, decorator: Google::Apis::DfareportingV2_7::Browser::Representation + + collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV2_7::ConnectionType, decorator: Google::Apis::DfareportingV2_7::ConnectionType::Representation + + collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV2_7::MobileCarrier, decorator: Google::Apis::DfareportingV2_7::MobileCarrier::Representation + + collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV2_7::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_7::OperatingSystemVersion::Representation + + collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV2_7::OperatingSystem, decorator: Google::Apis::DfareportingV2_7::OperatingSystem::Representation + + collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV2_7::PlatformType, decorator: Google::Apis::DfareportingV2_7::PlatformType::Representation + + end + end + + class ThirdPartyAuthenticationToken + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class ThirdPartyTrackingUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :third_party_url_type, as: 'thirdPartyUrlType' + property :url, as: 'url' + end + end + + class TranscodeSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :enabled_video_formats, as: 'enabledVideoFormats' + property :kind, as: 'kind' + end + end + + class UserDefinedVariableConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data_type, as: 'dataType' + property :report_name, as: 'reportName' + property :variable_type, as: 'variableType' + end + end + + class UserProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :account_name, as: 'accountName' + property :etag, as: 'etag' + property :kind, as: 'kind' + property :profile_id, as: 'profileId' + property :sub_account_id, as: 'subAccountId' + property :sub_account_name, as: 'subAccountName' + property :user_name, as: 'userName' + end + end + + class UserProfileList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV2_7::UserProfile, decorator: Google::Apis::DfareportingV2_7::UserProfile::Representation + + property :kind, as: 'kind' + end + end + + class UserRole + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :default_user_role, as: 'defaultUserRole' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :parent_user_role_id, as: 'parentUserRoleId' + collection :permissions, as: 'permissions', class: Google::Apis::DfareportingV2_7::UserRolePermission, decorator: Google::Apis::DfareportingV2_7::UserRolePermission::Representation + + property :subaccount_id, as: 'subaccountId' + end + end + + class UserRolePermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :availability, as: 'availability' + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :permission_group_id, as: 'permissionGroupId' + end + end + + class UserRolePermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class UserRolePermissionGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :user_role_permission_groups, as: 'userRolePermissionGroups', class: Google::Apis::DfareportingV2_7::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV2_7::UserRolePermissionGroup::Representation + + end + end + + class UserRolePermissionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :user_role_permissions, as: 'userRolePermissions', class: Google::Apis::DfareportingV2_7::UserRolePermission, decorator: Google::Apis::DfareportingV2_7::UserRolePermission::Representation + + end + end + + class UserRolesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :user_roles, as: 'userRoles', class: Google::Apis::DfareportingV2_7::UserRole, decorator: Google::Apis::DfareportingV2_7::UserRole::Representation + + end + end + + class VideoFormat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_type, as: 'fileType' + property :id, as: 'id' + property :kind, as: 'kind' + property :resolution, as: 'resolution', class: Google::Apis::DfareportingV2_7::Size, decorator: Google::Apis::DfareportingV2_7::Size::Representation + + property :target_bit_rate, as: 'targetBitRate' + end + end + + class VideoFormatsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :video_formats, as: 'videoFormats', class: Google::Apis::DfareportingV2_7::VideoFormat, decorator: Google::Apis::DfareportingV2_7::VideoFormat::Representation + + end + end + + class VideoOffset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :offset_percentage, as: 'offsetPercentage' + property :offset_seconds, as: 'offsetSeconds' + end + end + + class VideoSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companion_settings, as: 'companionSettings', class: Google::Apis::DfareportingV2_7::CompanionSetting, decorator: Google::Apis::DfareportingV2_7::CompanionSetting::Representation + + property :kind, as: 'kind' + property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV2_7::SkippableSetting, decorator: Google::Apis::DfareportingV2_7::SkippableSetting::Representation + + property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV2_7::TranscodeSetting, decorator: Google::Apis::DfareportingV2_7::TranscodeSetting::Representation + + end + end + end + end +end diff --git a/generated/google/apis/dfareporting_v2_7/service.rb b/generated/google/apis/dfareporting_v2_7/service.rb new file mode 100644 index 000000000..9c8d3762f --- /dev/null +++ b/generated/google/apis/dfareporting_v2_7/service.rb @@ -0,0 +1,9095 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV2_7 + # DCM/DFA Reporting And Trafficking API + # + # Manages your DoubleClick Campaign Manager ad campaigns and reports. + # + # @example + # require 'google/apis/dfareporting_v2_7' + # + # Dfareporting = Google::Apis::DfareportingV2_7 # Alias the module + # service = Dfareporting::DfareportingService.new + # + # @see https://developers.google.com/doubleclick-advertisers/ + class DfareportingService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + attr_accessor :quota_user + + # @return [String] + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + attr_accessor :user_ip + + def initialize + super('https://www.googleapis.com/', 'dfareporting/v2.7/') + end + + # Gets the account's active ad summary by account ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] summary_account_id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountActiveAdSummary] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountActiveAdSummary] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountActiveAdSummary::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountActiveAdSummary + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['summaryAccountId'] = summary_account_id unless summary_account_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account permission group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Account permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountPermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountPermissionGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountPermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountPermissionGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of account permission groups. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountPermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountPermissionGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountPermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountPermissionGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account permission by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Account permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountPermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountPermission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountPermission::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountPermission + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of account permissions. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountPermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountPermissionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_permissions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountPermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountPermissionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account user profile by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new account user profile. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of account user profiles, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active user profiles. + # @param [Array, String] ids + # Select only user profiles with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. + # For example, "user profile*2015" will return objects with names like "user + # profile June 2015", "user profile April 2015", or simply "user profile 2015". + # Most of the searches also add wildcards implicitly at the start and the end of + # the search string. For example, a search string of "user profile" will match + # objects with name "my user profile", "user profile 2015", or simply "user + # profile". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] subaccount_id + # Select only user profiles with the specified subaccount ID. + # @param [String] user_role_id + # Select only user profiles with the specified user role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountUserProfilesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountUserProfilesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_user_profiles(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, user_role_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountUserProfilesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountUserProfilesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['userRoleId'] = user_role_id unless user_role_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account user profile. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User profile ID. + # @param [Google::Apis::DfareportingV2_7::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account user profile. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV2_7::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Account::Representation + command.response_class = Google::Apis::DfareportingV2_7::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of accounts, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active accounts. Don't set this field to select both active and + # non-active accounts. + # @param [Array, String] ids + # Select only accounts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "account*2015" will return objects with names like "account June 2015" + # , "account April 2015", or simply "account 2015". Most of the searches also + # add wildcards implicitly at the start and the end of the search string. For + # example, a search string of "account" will match objects with name "my account" + # , "account 2015", or simply "account". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AccountsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accounts', options) + command.response_representation = Google::Apis::DfareportingV2_7::AccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AccountsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Account ID. + # @param [Google::Apis::DfareportingV2_7::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options) + command.request_representation = Google::Apis::DfareportingV2_7::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV2_7::Account::Representation + command.response_class = Google::Apis::DfareportingV2_7::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/accounts', options) + command.request_representation = Google::Apis::DfareportingV2_7::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV2_7::Account::Representation + command.response_class = Google::Apis::DfareportingV2_7::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one ad by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Ad ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.response_class = Google::Apis::DfareportingV2_7::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new ad. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.response_class = Google::Apis::DfareportingV2_7::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of ads, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active ads. + # @param [String] advertiser_id + # Select only ads with this advertiser ID. + # @param [Boolean] archived + # Select only archived ads. + # @param [Array, String] audience_segment_ids + # Select only ads with these audience segment IDs. + # @param [Array, String] campaign_ids + # Select only ads with these campaign IDs. + # @param [String] compatibility + # Select default ads with the specified compatibility. Applicable when type is + # AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # either on desktop or on mobile devices for regular or interstitial ads, + # respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. + # IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the + # VAST standard. + # @param [Array, String] creative_ids + # Select only ads with these creative IDs assigned. + # @param [Array, String] creative_optimization_configuration_ids + # Select only ads with these creative optimization configuration IDs. + # @param [Boolean] dynamic_click_tracker + # Select only dynamic click trackers. Applicable when type is + # AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, + # select static click trackers. Leave unset to select both. + # @param [Array, String] ids + # Select only ads with these IDs. + # @param [Array, String] landing_page_ids + # Select only ads with these landing page IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] overridden_event_tag_id + # Select only ads with this event tag override ID. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, String] placement_ids + # Select only ads with these placement IDs assigned. + # @param [Array, String] remarketing_list_ids + # Select only ads whose list targeting expression use these remarketing list IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "ad*2015" will return objects with names like "ad June 2015", "ad + # April 2015", or simply "ad 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "ad" will match objects with name "my ad", "ad 2015", or + # simply "ad". + # @param [Array, String] size_ids + # Select only ads with these size IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [Boolean] ssl_compliant + # Select only ads that are SSL-compliant. + # @param [Boolean] ssl_required + # Select only ads that require SSL. + # @param [Array, String] type + # Select only ads with these types. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_ads(profile_id, active: nil, advertiser_id: nil, archived: nil, audience_segment_ids: nil, campaign_ids: nil, compatibility: nil, creative_ids: nil, creative_optimization_configuration_ids: nil, dynamic_click_tracker: nil, ids: nil, landing_page_ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, placement_ids: nil, remarketing_list_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, ssl_compliant: nil, ssl_required: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/ads', options) + command.response_representation = Google::Apis::DfareportingV2_7::AdsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['archived'] = archived unless archived.nil? + command.query['audienceSegmentIds'] = audience_segment_ids unless audience_segment_ids.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['compatibility'] = compatibility unless compatibility.nil? + command.query['creativeIds'] = creative_ids unless creative_ids.nil? + command.query['creativeOptimizationConfigurationIds'] = creative_optimization_configuration_ids unless creative_optimization_configuration_ids.nil? + command.query['dynamicClickTracker'] = dynamic_click_tracker unless dynamic_click_tracker.nil? + command.query['ids'] = ids unless ids.nil? + command.query['landingPageIds'] = landing_page_ids unless landing_page_ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['placementIds'] = placement_ids unless placement_ids.nil? + command.query['remarketingListIds'] = remarketing_list_ids unless remarketing_list_ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['sslCompliant'] = ssl_compliant unless ssl_compliant.nil? + command.query['sslRequired'] = ssl_required unless ssl_required.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing ad. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Ad ID. + # @param [Google::Apis::DfareportingV2_7::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.response_class = Google::Apis::DfareportingV2_7::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing ad. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV2_7::Ad::Representation + command.response_class = Google::Apis::DfareportingV2_7::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing advertiser group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/advertiserGroups/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one advertiser group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new advertiser group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of advertiser groups, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Select only advertiser groups with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "advertiser*2015" will return objects with names like "advertiser + # group June 2015", "advertiser group April 2015", or simply "advertiser group + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "advertisergroup" + # will match objects with name "my advertisergroup", "advertisergroup 2015", or + # simply "advertisergroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertiserGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertiserGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::AdvertiserGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertiserGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser group. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Advertiser group ID. + # @param [Google::Apis::DfareportingV2_7::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV2_7::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one advertiser by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Advertiser ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV2_7::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new advertiser. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV2_7::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of advertisers, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_group_ids + # Select only advertisers with these advertiser group IDs. + # @param [Array, String] floodlight_configuration_ids + # Select only advertisers with these floodlight configuration IDs. + # @param [Array, String] ids + # Select only advertisers with these IDs. + # @param [Boolean] include_advertisers_without_groups_only + # Select only advertisers which do not belong to any advertiser group. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Boolean] only_parent + # Select only advertisers which use another advertiser's floodlight + # configuration. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "advertiser*2015" will return objects with names like "advertiser + # June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "advertiser" will match objects with + # name "my advertiser", "advertiser 2015", or simply "advertiser". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] status + # Select only advertisers with the specified status. + # @param [String] subaccount_id + # Select only advertisers with these subaccount IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::AdvertisersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::AdvertisersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertisers(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options) + command.response_representation = Google::Apis::DfareportingV2_7::AdvertisersListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::AdvertisersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? + command.query['floodlightConfigurationIds'] = floodlight_configuration_ids unless floodlight_configuration_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['includeAdvertisersWithoutGroupsOnly'] = include_advertisers_without_groups_only unless include_advertisers_without_groups_only.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['onlyParent'] = only_parent unless only_parent.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['status'] = status unless status.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Advertiser ID. + # @param [Google::Apis::DfareportingV2_7::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV2_7::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV2_7::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV2_7::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of browsers. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::BrowsersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::BrowsersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/browsers', options) + command.response_representation = Google::Apis::DfareportingV2_7::BrowsersListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::BrowsersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Associates a creative with the specified campaign. This method creates a + # default ad with dimensions matching the creative in the campaign if such a + # default ad does not exist already. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Campaign ID in this association. + # @param [Google::Apis::DfareportingV2_7::CampaignCreativeAssociation] campaign_creative_association_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CampaignCreativeAssociation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CampaignCreativeAssociation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) + command.request_representation = Google::Apis::DfareportingV2_7::CampaignCreativeAssociation::Representation + command.request_object = campaign_creative_association_object + command.response_representation = Google::Apis::DfareportingV2_7::CampaignCreativeAssociation::Representation + command.response_class = Google::Apis::DfareportingV2_7::CampaignCreativeAssociation + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of creative IDs associated with the specified campaign. + # This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Campaign ID in this association. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CampaignCreativeAssociationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CampaignCreativeAssociationsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) + command.response_representation = Google::Apis::DfareportingV2_7::CampaignCreativeAssociationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CampaignCreativeAssociationsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one campaign by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Campaign ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.response_class = Google::Apis::DfareportingV2_7::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new campaign. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] default_landing_page_name + # Default landing page name for this new campaign. Must be less than 256 + # characters long. + # @param [String] default_landing_page_url + # Default landing page URL for this new campaign. + # @param [Google::Apis::DfareportingV2_7::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_campaign(profile_id, default_landing_page_name, default_landing_page_url, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.response_class = Google::Apis::DfareportingV2_7::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['defaultLandingPageName'] = default_landing_page_name unless default_landing_page_name.nil? + command.query['defaultLandingPageUrl'] = default_landing_page_url unless default_landing_page_url.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of campaigns, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_group_ids + # Select only campaigns whose advertisers belong to these advertiser groups. + # @param [Array, String] advertiser_ids + # Select only campaigns that belong to these advertisers. + # @param [Boolean] archived + # Select only archived campaigns. Don't set this field to select both archived + # and non-archived campaigns. + # @param [Boolean] at_least_one_optimization_activity + # Select only campaigns that have at least one optimization activity. + # @param [Array, String] excluded_ids + # Exclude campaigns with these IDs. + # @param [Array, String] ids + # Select only campaigns with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] overridden_event_tag_id + # Select only campaigns that have overridden this event tag ID. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For + # example, "campaign*2015" will return campaigns with names like "campaign June + # 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "campaign" will match campaigns with name "my + # campaign", "campaign 2015", or simply "campaign". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] subaccount_id + # Select only campaigns that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CampaignsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CampaignsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options) + command.response_representation = Google::Apis::DfareportingV2_7::CampaignsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CampaignsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['atLeastOneOptimizationActivity'] = at_least_one_optimization_activity unless at_least_one_optimization_activity.nil? + command.query['excludedIds'] = excluded_ids unless excluded_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Campaign ID. + # @param [Google::Apis::DfareportingV2_7::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.response_class = Google::Apis::DfareportingV2_7::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV2_7::Campaign::Representation + command.response_class = Google::Apis::DfareportingV2_7::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one change log by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Change log ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ChangeLog] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ChangeLog] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::ChangeLog::Representation + command.response_class = Google::Apis::DfareportingV2_7::ChangeLog + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of change logs. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] action + # Select only change logs with the specified action. + # @param [Array, String] ids + # Select only change logs with these IDs. + # @param [String] max_change_time + # Select only change logs whose change time is before the specified + # maxChangeTime.The time should be formatted as an RFC3339 date/time string. For + # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, + # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, + # day, the letter T, the hour (24-hour clock system), minute, second, and then + # the time zone offset. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] min_change_time + # Select only change logs whose change time is before the specified + # minChangeTime.The time should be formatted as an RFC3339 date/time string. For + # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, + # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, + # day, the letter T, the hour (24-hour clock system), minute, second, and then + # the time zone offset. + # @param [Array, String] object_ids + # Select only change logs with these object IDs. + # @param [String] object_type + # Select only change logs with the specified object type. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Select only change logs whose object ID, user name, old or new values match + # the search string. + # @param [Array, String] user_profile_ids + # Select only change logs with these user profile IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ChangeLogsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ChangeLogsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options) + command.response_representation = Google::Apis::DfareportingV2_7::ChangeLogsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::ChangeLogsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['action'] = action unless action.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxChangeTime'] = max_change_time unless max_change_time.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['minChangeTime'] = min_change_time unless min_change_time.nil? + command.query['objectIds'] = object_ids unless object_ids.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['userProfileIds'] = user_profile_ids unless user_profile_ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of cities, possibly filtered. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] country_dart_ids + # Select only cities from these countries. + # @param [Array, String] dart_ids + # Select only cities with these DART IDs. + # @param [String] name_prefix + # Select only cities with names starting with this prefix. + # @param [Array, String] region_dart_ids + # Select only cities from these regions. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CitiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/cities', options) + command.response_representation = Google::Apis::DfareportingV2_7::CitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CitiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['countryDartIds'] = country_dart_ids unless country_dart_ids.nil? + command.query['dartIds'] = dart_ids unless dart_ids.nil? + command.query['namePrefix'] = name_prefix unless name_prefix.nil? + command.query['regionDartIds'] = region_dart_ids unless region_dart_ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one connection type by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Connection type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ConnectionType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ConnectionType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::ConnectionType::Representation + command.response_class = Google::Apis::DfareportingV2_7::ConnectionType + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of connection types. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ConnectionTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ConnectionTypesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options) + command.response_representation = Google::Apis::DfareportingV2_7::ConnectionTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::ConnectionTypesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing content category. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/contentCategories/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one content category by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV2_7::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new content category. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV2_7::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of content categories, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Select only content categories with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "contentcategory*2015" will return objects with names like " + # contentcategory June 2015", "contentcategory April 2015", or simply " + # contentcategory 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # contentcategory" will match objects with name "my contentcategory", " + # contentcategory 2015", or simply "contentcategory". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ContentCategoriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ContentCategoriesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options) + command.response_representation = Google::Apis::DfareportingV2_7::ContentCategoriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::ContentCategoriesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing content category. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Content category ID. + # @param [Google::Apis::DfareportingV2_7::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV2_7::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing content category. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV2_7::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV2_7::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts conversions. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::ConversionsBatchInsertRequest] conversions_batch_insert_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ConversionsBatchInsertResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ConversionsBatchInsertResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchinsert', options) + command.request_representation = Google::Apis::DfareportingV2_7::ConversionsBatchInsertRequest::Representation + command.request_object = conversions_batch_insert_request_object + command.response_representation = Google::Apis::DfareportingV2_7::ConversionsBatchInsertResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::ConversionsBatchInsertResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one country by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] dart_id + # Country DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Country] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Country] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Country::Representation + command.response_class = Google::Apis::DfareportingV2_7::Country + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['dartId'] = dart_id unless dart_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of countries. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CountriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CountriesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/countries', options) + command.response_representation = Google::Apis::DfareportingV2_7::CountriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CountriesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative asset. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Advertiser ID of this creative. This is a required field. + # @param [Google::Apis::DfareportingV2_7::CreativeAssetMetadata] creative_asset_metadata_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] upload_source + # IO stream or filename containing content to upload + # @param [String] content_type + # Content type of the uploaded content. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeAssetMetadata] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeAssetMetadata] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) + else + command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::DfareportingV2_7::CreativeAssetMetadata::Representation + command.request_object = creative_asset_metadata_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeAssetMetadata::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeAssetMetadata + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing creative field value. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [String] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative field value by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [String] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative field value. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV2_7::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative field values, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [Array, String] ids + # Select only creative field values with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative field values by their values. Wildcards (e.g. *) + # are not allowed. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldValuesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldValuesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldValuesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldValuesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field value. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [String] id + # Creative Field Value ID + # @param [Google::Apis::DfareportingV2_7::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field value. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV2_7::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing creative field. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative field by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative field. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative fields, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_ids + # Select only creative fields that belong to these advertisers. + # @param [Array, String] ids + # Select only creative fields with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative fields by name or ID. Wildcards (*) are allowed. + # For example, "creativefield*2015" will return creative fields with names like " + # creativefield June 2015", "creativefield April 2015", or simply "creativefield + # 2015". Most of the searches also add wild-cards implicitly at the start and + # the end of the search string. For example, a search string of "creativefield" + # will match creative fields with the name "my creativefield", "creativefield + # 2015", or simply "creativefield". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeFieldsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeFieldsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeFieldsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeFieldsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative Field ID + # @param [Google::Apis::DfareportingV2_7::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative groups, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_ids + # Select only creative groups that belong to these advertisers. + # @param [Fixnum] group_number + # Select only creative groups that belong to this subgroup. + # @param [Array, String] ids + # Select only creative groups with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative groups by name or ID. Wildcards (*) are allowed. + # For example, "creativegroup*2015" will return creative groups with names like " + # creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup + # 2015". Most of the searches also add wild-cards implicitly at the start and + # the end of the search string. For example, a search string of "creativegroup" + # will match creative groups with the name "my creativegroup", "creativegroup + # 2015", or simply "creativegroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativeGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['groupNumber'] = group_number unless group_number.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative group. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative group ID. + # @param [Google::Apis::DfareportingV2_7::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV2_7::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.response_class = Google::Apis::DfareportingV2_7::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.response_class = Google::Apis::DfareportingV2_7::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creatives, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active creatives. Leave blank to select active and inactive + # creatives. + # @param [String] advertiser_id + # Select only creatives with this advertiser ID. + # @param [Boolean] archived + # Select only archived creatives. Leave blank to select archived and unarchived + # creatives. + # @param [String] campaign_id + # Select only creatives with this campaign ID. + # @param [Array, String] companion_creative_ids + # Select only in-stream video creatives with these companion IDs. + # @param [Array, String] creative_field_ids + # Select only creatives with these creative field IDs. + # @param [Array, String] ids + # Select only creatives with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, String] rendering_ids + # Select only creatives with these rendering IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "creative*2015" will return objects with names like "creative June + # 2015", "creative April 2015", or simply "creative 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "creative" will match objects with name "my + # creative", "creative 2015", or simply "creative". + # @param [Array, String] size_ids + # Select only creatives with these size IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] studio_creative_id + # Select only creatives corresponding to this Studio creative ID. + # @param [Array, String] types + # Select only creatives with these creative types. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CreativesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CreativesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creatives', options) + command.response_representation = Google::Apis::DfareportingV2_7::CreativesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::CreativesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['companionCreativeIds'] = companion_creative_ids unless companion_creative_ids.nil? + command.query['creativeFieldIds'] = creative_field_ids unless creative_field_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['renderingIds'] = rendering_ids unless rendering_ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['studioCreativeId'] = studio_creative_id unless studio_creative_id.nil? + command.query['types'] = types unless types.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Creative ID. + # @param [Google::Apis::DfareportingV2_7::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.response_class = Google::Apis::DfareportingV2_7::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV2_7::Creative::Representation + command.response_class = Google::Apis::DfareportingV2_7::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of report dimension values for a list of filters. + # @param [String] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV2_7::DimensionValueRequest] dimension_value_request_object + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DimensionValueList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DimensionValueList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options) + command.request_representation = Google::Apis::DfareportingV2_7::DimensionValueRequest::Representation + command.request_object = dimension_value_request_object + command.response_representation = Google::Apis::DfareportingV2_7::DimensionValueList::Representation + command.response_class = Google::Apis::DfareportingV2_7::DimensionValueList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one directory site contact by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Directory site contact ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DirectorySiteContact] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DirectorySiteContact] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::DirectorySiteContact::Representation + command.response_class = Google::Apis::DfareportingV2_7::DirectorySiteContact + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of directory site contacts, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] directory_site_ids + # Select only directory site contacts with these directory site IDs. This is a + # required field. + # @param [Array, String] ids + # Select only directory site contacts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. + # For example, "directory site contact*2015" will return objects with names like + # "directory site contact June 2015", "directory site contact April 2015", or + # simply "directory site contact 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "directory site contact" will match objects with name "my + # directory site contact", "directory site contact 2015", or simply "directory + # site contact". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DirectorySiteContactsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DirectorySiteContactsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts', options) + command.response_representation = Google::Apis::DfareportingV2_7::DirectorySiteContactsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::DirectorySiteContactsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one directory site by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Directory site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DirectorySite] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV2_7::DirectorySite + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new directory site. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::DirectorySite] directory_site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DirectorySite] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options) + command.request_representation = Google::Apis::DfareportingV2_7::DirectorySite::Representation + command.request_object = directory_site_object + command.response_representation = Google::Apis::DfareportingV2_7::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV2_7::DirectorySite + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of directory sites, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] accepts_in_stream_video_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_interstitial_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_publisher_paid_placements + # Select only directory sites that accept publisher paid placements. This field + # can be left blank. + # @param [Boolean] active + # Select only active directory sites. Leave blank to retrieve both active and + # inactive directory sites. + # @param [String] country_id + # Select only directory sites with this country ID. + # @param [String] dfp_network_code + # Select only directory sites with this DFP network code. + # @param [Array, String] ids + # Select only directory sites with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] parent_id + # Select only directory sites with this parent ID. + # @param [String] search_string + # Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. + # For example, "directory site*2015" will return objects with names like " + # directory site June 2015", "directory site April 2015", or simply "directory + # site 2015". Most of the searches also add wildcards implicitly at the start + # and the end of the search string. For example, a search string of "directory + # site" will match objects with name "my directory site", "directory site 2015" + # or simply, "directory site". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DirectorySitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DirectorySitesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options) + command.response_representation = Google::Apis::DfareportingV2_7::DirectorySitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::DirectorySitesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? + command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? + command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? + command.query['active'] = active unless active.nil? + command.query['countryId'] = country_id unless country_id.nil? + command.query['dfp_network_code'] = dfp_network_code unless dfp_network_code.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing dynamic targeting key. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] object_id_ + # ID of the object of this dynamic targeting key. This is a required field. + # @param [String] name + # Name of this dynamic targeting key. This is a required field. Must be less + # than 256 characters long and cannot contain commas. All characters are + # converted to lowercase. + # @param [String] object_type + # Type of the object of this dynamic targeting key. This is a required field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/dynamicTargetingKeys/{objectId}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['objectId'] = object_id_ unless object_id_.nil? + command.query['name'] = name unless name.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new dynamic targeting key. Keys must be created at the advertiser + # level before being assigned to the advertiser's ads, creatives, or placements. + # There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 + # keys can be assigned per ad, creative, or placement. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::DynamicTargetingKey] dynamic_targeting_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DynamicTargetingKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DynamicTargetingKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/dynamicTargetingKeys', options) + command.request_representation = Google::Apis::DfareportingV2_7::DynamicTargetingKey::Representation + command.request_object = dynamic_targeting_key_object + command.response_representation = Google::Apis::DfareportingV2_7::DynamicTargetingKey::Representation + command.response_class = Google::Apis::DfareportingV2_7::DynamicTargetingKey + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of dynamic targeting keys. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only dynamic targeting keys whose object has this advertiser ID. + # @param [Array, String] names + # Select only dynamic targeting keys exactly matching these names. + # @param [String] object_id_ + # Select only dynamic targeting keys with this object ID. + # @param [String] object_type + # Select only dynamic targeting keys with this object type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::DynamicTargetingKeysListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::DynamicTargetingKeysListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options) + command.response_representation = Google::Apis::DfareportingV2_7::DynamicTargetingKeysListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::DynamicTargetingKeysListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['names'] = names unless names.nil? + command.query['objectId'] = object_id_ unless object_id_.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing event tag. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/eventTags/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one event tag by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.response_class = Google::Apis::DfareportingV2_7::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new event tag. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.response_class = Google::Apis::DfareportingV2_7::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of event tags, possibly filtered. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] ad_id + # Select only event tags that belong to this ad. + # @param [String] advertiser_id + # Select only event tags that belong to this advertiser. + # @param [String] campaign_id + # Select only event tags that belong to this campaign. + # @param [Boolean] definitions_only + # Examine only the specified campaign or advertiser's event tags for matching + # selector criteria. When set to false, the parent advertiser and parent + # campaign of the specified ad or campaign is examined as well. In addition, + # when set to false, the status field is examined as well, along with the + # enabledByDefault field. This parameter can not be set to true when adId is + # specified as ads do not define their own even tags. + # @param [Boolean] enabled + # Select only enabled event tags. What is considered enabled or disabled depends + # on the definitionsOnly parameter. When definitionsOnly is set to true, only + # the specified advertiser or campaign's event tags' enabledByDefault field is + # examined. When definitionsOnly is set to false, the specified ad or specified + # campaign's parent advertiser's or parent campaign's event tags' + # enabledByDefault and status fields are examined as well. + # @param [Array, String] event_tag_types + # Select only event tags with the specified event tag types. Event tag types can + # be used to specify whether to use a third-party pixel, a third-party + # JavaScript URL, or a third-party click-through URL for either impression or + # click tracking. + # @param [Array, String] ids + # Select only event tags with these IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "eventtag*2015" will return objects with names like "eventtag June + # 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "eventtag" will match objects with name "my + # eventtag", "eventtag 2015", or simply "eventtag". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::EventTagsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::EventTagsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options) + command.response_representation = Google::Apis::DfareportingV2_7::EventTagsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::EventTagsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['adId'] = ad_id unless ad_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['definitionsOnly'] = definitions_only unless definitions_only.nil? + command.query['enabled'] = enabled unless enabled.nil? + command.query['eventTagTypes'] = event_tag_types unless event_tag_types.nil? + command.query['ids'] = ids unless ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing event tag. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Event tag ID. + # @param [Google::Apis::DfareportingV2_7::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.response_class = Google::Apis::DfareportingV2_7::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing event tag. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV2_7::EventTag::Representation + command.response_class = Google::Apis::DfareportingV2_7::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report file by its report ID and file ID. + # @param [String] report_id + # The ID of the report. + # @param [String] file_id + # The ID of the report file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options) + else + command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DfareportingV2_7::File::Representation + command.response_class = Google::Apis::DfareportingV2_7::File + command.params['reportId'] = report_id unless report_id.nil? + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists files for a user profile. + # @param [String] profile_id + # The DFA profile ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] scope + # The scope that defines which results are returned, default is 'MINE'. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is 'DESCENDING'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/files', options) + command.response_representation = Google::Apis::DfareportingV2_7::FileList::Representation + command.response_class = Google::Apis::DfareportingV2_7::FileList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['scope'] = scope unless scope.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing floodlight activity. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/floodlightActivities/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Generates a tag for a floodlight activity. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] floodlight_activity_id + # Floodlight activity ID for which we want to generate a tag. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivitiesGenerateTagResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivitiesGenerateTagResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivitiesGenerateTagResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivitiesGenerateTagResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight activity by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new floodlight activity. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight activities, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only floodlight activities for the specified advertiser ID. Must + # specify either ids, advertiserId, or floodlightConfigurationId for a non-empty + # result. + # @param [Array, String] floodlight_activity_group_ids + # Select only floodlight activities with the specified floodlight activity group + # IDs. + # @param [String] floodlight_activity_group_name + # Select only floodlight activities with the specified floodlight activity group + # name. + # @param [String] floodlight_activity_group_tag_string + # Select only floodlight activities with the specified floodlight activity group + # tag string. + # @param [String] floodlight_activity_group_type + # Select only floodlight activities with the specified floodlight activity group + # type. + # @param [String] floodlight_configuration_id + # Select only floodlight activities for the specified floodlight configuration + # ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a + # non-empty result. + # @param [Array, String] ids + # Select only floodlight activities with the specified IDs. Must specify either + # ids, advertiserId, or floodlightConfigurationId for a non-empty result. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "floodlightactivity*2015" will return objects with names like " + # floodlightactivity June 2015", "floodlightactivity April 2015", or simply " + # floodlightactivity 2015". Most of the searches also add wildcards implicitly + # at the start and the end of the search string. For example, a search string of + # "floodlightactivity" will match objects with name "my floodlightactivity + # activity", "floodlightactivity 2015", or simply "floodlightactivity". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] tag_string + # Select only floodlight activities with the specified tag string. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivitiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivitiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightActivityGroupIds'] = floodlight_activity_group_ids unless floodlight_activity_group_ids.nil? + command.query['floodlightActivityGroupName'] = floodlight_activity_group_name unless floodlight_activity_group_name.nil? + command.query['floodlightActivityGroupTagString'] = floodlight_activity_group_tag_string unless floodlight_activity_group_tag_string.nil? + command.query['floodlightActivityGroupType'] = floodlight_activity_group_type unless floodlight_activity_group_type.nil? + command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['tagString'] = tag_string unless tag_string.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight activity ID. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight activity group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight activity Group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new floodlight activity group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight activity groups, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only floodlight activity groups with the specified advertiser ID. Must + # specify either advertiserId or floodlightConfigurationId for a non-empty + # result. + # @param [String] floodlight_configuration_id + # Select only floodlight activity groups with the specified floodlight + # configuration ID. Must specify either advertiserId, or + # floodlightConfigurationId for a non-empty result. + # @param [Array, String] ids + # Select only floodlight activity groups with the specified IDs. Must specify + # either advertiserId or floodlightConfigurationId for a non-empty result. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "floodlightactivitygroup*2015" will return objects with names like " + # floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or + # simply "floodlightactivitygroup 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "floodlightactivitygroup" will match objects with name "my + # floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply " + # floodlightactivitygroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] type + # Select only floodlight activity groups with the specified floodlight activity + # group type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivityGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivityGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity group. This method supports patch + # semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight activity Group ID. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight configuration by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight configuration ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight configurations, possibly filtered. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Set of IDs of floodlight configurations to retrieve. Required field; otherwise + # an empty list will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightConfigurationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightConfigurationsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightConfigurationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightConfigurationsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight configuration. This method supports patch + # semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Floodlight configuration ID. + # @param [Google::Apis::DfareportingV2_7::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight configuration. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.request_representation = Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV2_7::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV2_7::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one inventory item by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for order documents. + # @param [String] id + # Inventory item ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::InventoryItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::InventoryItem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::InventoryItem::Representation + command.response_class = Google::Apis::DfareportingV2_7::InventoryItem + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of inventory items, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for order documents. + # @param [Array, String] ids + # Select only inventory items with these IDs. + # @param [Boolean] in_plan + # Select only inventory items that are in plan. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Array, String] order_id + # Select only inventory items that belong to specified orders. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, String] site_id + # Select only inventory items that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] type + # Select only inventory items with this type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::InventoryItemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::InventoryItemsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_inventory_items(profile_id, project_id, ids: nil, in_plan: nil, max_results: nil, order_id: nil, page_token: nil, site_id: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options) + command.response_representation = Google::Apis::DfareportingV2_7::InventoryItemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::InventoryItemsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['inPlan'] = in_plan unless in_plan.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderId'] = order_id unless order_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing campaign landing page. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [String] id + # Landing page ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one campaign landing page by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [String] id + # Landing page ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV2_7::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new landing page for the specified campaign. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [Google::Apis::DfareportingV2_7::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) + command.request_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV2_7::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of landing pages for the specified campaign. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LandingPagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LandingPagesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_landing_pages(profile_id, campaign_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) + command.response_representation = Google::Apis::DfareportingV2_7::LandingPagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::LandingPagesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign landing page. This method supports patch + # semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [String] id + # Landing page ID. + # @param [Google::Apis::DfareportingV2_7::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_landing_page(profile_id, campaign_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) + command.request_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV2_7::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign landing page. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Landing page campaign ID. + # @param [Google::Apis::DfareportingV2_7::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) + command.request_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV2_7::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV2_7::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of languages. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::LanguagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::LanguagesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/languages', options) + command.response_representation = Google::Apis::DfareportingV2_7::LanguagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::LanguagesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of metros. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::MetrosListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::MetrosListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/metros', options) + command.response_representation = Google::Apis::DfareportingV2_7::MetrosListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::MetrosListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one mobile carrier by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Mobile carrier ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::MobileCarrier] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::MobileCarrier] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::MobileCarrier::Representation + command.response_class = Google::Apis::DfareportingV2_7::MobileCarrier + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of mobile carriers. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::MobileCarriersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::MobileCarriersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options) + command.response_representation = Google::Apis::DfareportingV2_7::MobileCarriersListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::MobileCarriersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one operating system version by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Operating system version ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OperatingSystemVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OperatingSystemVersion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::OperatingSystemVersion::Representation + command.response_class = Google::Apis::DfareportingV2_7::OperatingSystemVersion + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of operating system versions. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OperatingSystemVersionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OperatingSystemVersionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options) + command.response_representation = Google::Apis::DfareportingV2_7::OperatingSystemVersionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::OperatingSystemVersionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one operating system by DART ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] dart_id + # Operating system DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OperatingSystem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OperatingSystem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::OperatingSystem::Representation + command.response_class = Google::Apis::DfareportingV2_7::OperatingSystem + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['dartId'] = dart_id unless dart_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of operating systems. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OperatingSystemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OperatingSystemsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options) + command.response_representation = Google::Apis::DfareportingV2_7::OperatingSystemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::OperatingSystemsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one order document by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for order documents. + # @param [String] id + # Order document ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OrderDocument] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OrderDocument] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::OrderDocument::Representation + command.response_class = Google::Apis::DfareportingV2_7::OrderDocument + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of order documents, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for order documents. + # @param [Boolean] approved + # Select only order documents that have been approved by at least one user. + # @param [Array, String] ids + # Select only order documents with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Array, String] order_id + # Select only order documents for specified orders. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for order documents by name or ID. Wildcards (*) are allowed. + # For example, "orderdocument*2015" will return order documents with names like " + # orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "orderdocument" will + # match order documents with name "my orderdocument", "orderdocument 2015", or + # simply "orderdocument". + # @param [Array, String] site_id + # Select only order documents that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OrderDocumentsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OrderDocumentsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options) + command.response_representation = Google::Apis::DfareportingV2_7::OrderDocumentsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::OrderDocumentsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['approved'] = approved unless approved.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderId'] = order_id unless order_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one order by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for orders. + # @param [String] id + # Order ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Order] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Order] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Order::Representation + command.response_class = Google::Apis::DfareportingV2_7::Order + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of orders, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] project_id + # Project ID for orders. + # @param [Array, String] ids + # Select only orders with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for orders by name or ID. Wildcards (*) are allowed. For + # example, "order*2015" will return orders with names like "order June 2015", " + # order April 2015", or simply "order 2015". Most of the searches also add + # wildcards implicitly at the start and the end of the search string. For + # example, a search string of "order" will match orders with name "my order", " + # order 2015", or simply "order". + # @param [Array, String] site_id + # Select only orders that are associated with these site IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::OrdersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::OrdersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options) + command.response_representation = Google::Apis::DfareportingV2_7::OrdersListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::OrdersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placement groups, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_ids + # Select only placement groups that belong to these advertisers. + # @param [Boolean] archived + # Select only archived placements. Don't set this field to select both archived + # and non-archived placements. + # @param [Array, String] campaign_ids + # Select only placement groups that belong to these campaigns. + # @param [Array, String] content_category_ids + # Select only placement groups that are associated with these content categories. + # @param [Array, String] directory_site_ids + # Select only placement groups that are associated with these directory sites. + # @param [Array, String] ids + # Select only placement groups with these IDs. + # @param [String] max_end_date + # Select only placements or placement groups whose end date is on or before the + # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] max_start_date + # Select only placements or placement groups whose start date is on or before + # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_end_date + # Select only placements or placement groups whose end date is on or after the + # specified minEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_start_date + # Select only placements or placement groups whose start date is on or after the + # specified minStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] placement_group_type + # Select only placement groups belonging with this group type. A package is a + # simple group of placements that acts as a single pricing point for a group of + # tags. A roadblock is a group of placements that not only acts as a single + # pricing point but also assumes that all the tags in it will be served at the + # same time. A roadblock requires one of its assigned placements to be marked as + # primary for reporting. + # @param [Array, String] placement_strategy_ids + # Select only placement groups that are associated with these placement + # strategies. + # @param [Array, String] pricing_types + # Select only placement groups with these pricing types. + # @param [String] search_string + # Allows searching for placement groups by name or ID. Wildcards (*) are allowed. + # For example, "placement*2015" will return placement groups with names like " + # placement group June 2015", "placement group May 2015", or simply "placements + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "placementgroup" + # will match placement groups with name "my placementgroup", "placementgroup + # 2015", or simply "placementgroup". + # @param [Array, String] site_ids + # Select only placement groups that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxEndDate'] = max_end_date unless max_end_date.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['maxStartDate'] = max_start_date unless max_start_date.nil? + command.query['minEndDate'] = min_end_date unless min_end_date.nil? + command.query['minStartDate'] = min_start_date unless min_start_date.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['placementGroupType'] = placement_group_type unless placement_group_type.nil? + command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? + command.query['pricingTypes'] = pricing_types unless pricing_types.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteIds'] = site_ids unless site_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement group. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement group ID. + # @param [Google::Apis::DfareportingV2_7::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement group. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing placement strategy. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/placementStrategies/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement strategy by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement strategy. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placement strategies, possibly filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Select only placement strategies with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "placementstrategy*2015" will return objects with names like " + # placementstrategy June 2015", "placementstrategy April 2015", or simply " + # placementstrategy 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # placementstrategy" will match objects with name "my placementstrategy", " + # placementstrategy 2015", or simply "placementstrategy". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementStrategiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementStrategiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementStrategiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementStrategiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement strategy. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement strategy ID. + # @param [Google::Apis::DfareportingV2_7::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement strategy. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV2_7::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Generates tags for a placement. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] campaign_id + # Generate placements belonging to this campaign. This is a required field. + # @param [Array, String] placement_ids + # Generate tags for these placements. + # @param [Array, String] tag_formats + # Tag formats to generate for these placements. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementsGenerateTagsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementsGenerateTagsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementsGenerateTagsResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementsGenerateTagsResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['placementIds'] = placement_ids unless placement_ids.nil? + command.query['tagFormats'] = tag_formats unless tag_formats.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.response_class = Google::Apis::DfareportingV2_7::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.response_class = Google::Apis::DfareportingV2_7::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placements, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_ids + # Select only placements that belong to these advertisers. + # @param [Boolean] archived + # Select only archived placements. Don't set this field to select both archived + # and non-archived placements. + # @param [Array, String] campaign_ids + # Select only placements that belong to these campaigns. + # @param [Array, String] compatibilities + # Select only placements that are associated with these compatibilities. DISPLAY + # and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile + # devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL + # are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in- + # stream video ads developed with the VAST standard. + # @param [Array, String] content_category_ids + # Select only placements that are associated with these content categories. + # @param [Array, String] directory_site_ids + # Select only placements that are associated with these directory sites. + # @param [Array, String] group_ids + # Select only placements that belong to these placement groups. + # @param [Array, String] ids + # Select only placements with these IDs. + # @param [String] max_end_date + # Select only placements or placement groups whose end date is on or before the + # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] max_start_date + # Select only placements or placement groups whose start date is on or before + # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_end_date + # Select only placements or placement groups whose end date is on or after the + # specified minEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_start_date + # Select only placements or placement groups whose start date is on or after the + # specified minStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] payment_source + # Select only placements with this payment source. + # @param [Array, String] placement_strategy_ids + # Select only placements that are associated with these placement strategies. + # @param [Array, String] pricing_types + # Select only placements with these pricing types. + # @param [String] search_string + # Allows searching for placements by name or ID. Wildcards (*) are allowed. For + # example, "placement*2015" will return placements with names like "placement + # June 2015", "placement May 2015", or simply "placements 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "placement" will match placements with + # name "my placement", "placement 2015", or simply "placement". + # @param [Array, String] site_ids + # Select only placements that are associated with these sites. + # @param [Array, String] size_ids + # Select only placements that are associated with these sizes. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlacementsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlacementsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placements', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlacementsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlacementsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['compatibilities'] = compatibilities unless compatibilities.nil? + command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['groupIds'] = group_ids unless group_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxEndDate'] = max_end_date unless max_end_date.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['maxStartDate'] = max_start_date unless max_start_date.nil? + command.query['minEndDate'] = min_end_date unless min_end_date.nil? + command.query['minStartDate'] = min_start_date unless min_start_date.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['paymentSource'] = payment_source unless payment_source.nil? + command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? + command.query['pricingTypes'] = pricing_types unless pricing_types.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteIds'] = site_ids unless site_ids.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Placement ID. + # @param [Google::Apis::DfareportingV2_7::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.response_class = Google::Apis::DfareportingV2_7::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV2_7::Placement::Representation + command.response_class = Google::Apis::DfareportingV2_7::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one platform type by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Platform type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlatformType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlatformType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlatformType::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlatformType + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of platform types. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PlatformTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PlatformTypesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options) + command.response_representation = Google::Apis::DfareportingV2_7::PlatformTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PlatformTypesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one postal code by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] code + # Postal code ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PostalCode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PostalCode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options) + command.response_representation = Google::Apis::DfareportingV2_7::PostalCode::Representation + command.response_class = Google::Apis::DfareportingV2_7::PostalCode + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['code'] = code unless code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of postal codes. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::PostalCodesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::PostalCodesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options) + command.response_representation = Google::Apis::DfareportingV2_7::PostalCodesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::PostalCodesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one project by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Project ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Project] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Project] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Project::Representation + command.response_class = Google::Apis::DfareportingV2_7::Project + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of projects, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] advertiser_ids + # Select only projects with these advertiser IDs. + # @param [Array, String] ids + # Select only projects with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for projects by name or ID. Wildcards (*) are allowed. For + # example, "project*2015" will return projects with names like "project June + # 2015", "project April 2015", or simply "project 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "project" will match projects with name "my + # project", "project 2015", or simply "project". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ProjectsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ProjectsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects', options) + command.response_representation = Google::Apis::DfareportingV2_7::ProjectsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::ProjectsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of regions. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RegionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RegionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/regions', options) + command.response_representation = Google::Apis::DfareportingV2_7::RegionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::RegionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list share by remarketing list ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] remarketing_list_id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list share. This method supports patch + # semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] remarketing_list_id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV2_7::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options) + command.request_representation = Google::Apis::DfareportingV2_7::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list share. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options) + command.request_representation = Google::Apis::DfareportingV2_7::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new remarketing list. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of remarketing lists, possibly filtered. This method supports + # paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only remarketing lists owned by this advertiser. + # @param [Boolean] active + # Select only active or only inactive remarketing lists. + # @param [String] floodlight_activity_id + # Select only remarketing lists that have this floodlight activity ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] name + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "remarketing list*2015" will return objects with names like " + # remarketing list June 2015", "remarketing list April 2015", or simply " + # remarketing list 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # remarketing list" will match objects with name "my remarketing list", " + # remarketing list 2015", or simply "remarketing list". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingListsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options) + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingListsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['name'] = name unless name.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV2_7::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV2_7::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV2_7::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a report by its ID. + # @param [String] profile_id + # The DFA user profile ID. + # @param [String] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/reports/{reportId}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report by its ID. + # @param [String] profile_id + # The DFA user profile ID. + # @param [String] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.response_class = Google::Apis::DfareportingV2_7::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a report. + # @param [String] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV2_7::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports', options) + command.request_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.response_class = Google::Apis::DfareportingV2_7::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of reports. + # @param [String] profile_id + # The DFA user profile ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] scope + # The scope that defines which results are returned, default is 'MINE'. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is 'DESCENDING'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::ReportList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::ReportList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports', options) + command.response_representation = Google::Apis::DfareportingV2_7::ReportList::Representation + command.response_class = Google::Apis::DfareportingV2_7::ReportList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['scope'] = scope unless scope.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a report. This method supports patch semantics. + # @param [String] profile_id + # The DFA user profile ID. + # @param [String] report_id + # The ID of the report. + # @param [Google::Apis::DfareportingV2_7::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options) + command.request_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.response_class = Google::Apis::DfareportingV2_7::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Runs a report. + # @param [String] profile_id + # The DFA profile ID. + # @param [String] report_id + # The ID of the report. + # @param [Boolean] synchronous + # If set and true, tries to run the report synchronously. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options) + command.response_representation = Google::Apis::DfareportingV2_7::File::Representation + command.response_class = Google::Apis::DfareportingV2_7::File + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['synchronous'] = synchronous unless synchronous.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a report. + # @param [String] profile_id + # The DFA user profile ID. + # @param [String] report_id + # The ID of the report. + # @param [Google::Apis::DfareportingV2_7::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options) + command.request_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.response_class = Google::Apis::DfareportingV2_7::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the fields that are compatible to be selected in the respective + # sections of a report criteria, given the fields already selected in the input + # report and user permissions. + # @param [String] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV2_7::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::CompatibleFields] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::CompatibleFields] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options) + command.request_representation = Google::Apis::DfareportingV2_7::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV2_7::CompatibleFields::Representation + command.response_class = Google::Apis::DfareportingV2_7::CompatibleFields + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report file. + # @param [String] profile_id + # The DFA profile ID. + # @param [String] report_id + # The ID of the report. + # @param [String] file_id + # The ID of the report file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) + else + command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DfareportingV2_7::File::Representation + command.response_class = Google::Apis::DfareportingV2_7::File + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists files for a report. + # @param [String] profile_id + # The DFA profile ID. + # @param [String] report_id + # The ID of the parent report. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is 'DESCENDING'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::FileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options) + command.response_representation = Google::Apis::DfareportingV2_7::FileList::Representation + command.response_class = Google::Apis::DfareportingV2_7::FileList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one site by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.response_class = Google::Apis::DfareportingV2_7::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new site. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.response_class = Google::Apis::DfareportingV2_7::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of sites, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] accepts_in_stream_video_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_interstitial_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_publisher_paid_placements + # Select only sites that accept publisher paid placements. + # @param [Boolean] ad_words_site + # Select only AdWords sites. + # @param [Boolean] approved + # Select only approved sites. + # @param [Array, String] campaign_ids + # Select only sites with these campaign IDs. + # @param [Array, String] directory_site_ids + # Select only sites with these directory site IDs. + # @param [Array, String] ids + # Select only sites with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. + # For example, "site*2015" will return objects with names like "site June 2015", + # "site April 2015", or simply "site 2015". Most of the searches also add + # wildcards implicitly at the start and the end of the search string. For + # example, a search string of "site" will match objects with name "my site", " + # site 2015", or simply "site". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] subaccount_id + # Select only sites with this subaccount ID. + # @param [Boolean] unmapped_site + # Select only sites that have not been mapped to a directory site. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::SitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::SitesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sites', options) + command.response_representation = Google::Apis::DfareportingV2_7::SitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::SitesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? + command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? + command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? + command.query['adWordsSite'] = ad_words_site unless ad_words_site.nil? + command.query['approved'] = approved unless approved.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['unmappedSite'] = unmapped_site unless unmapped_site.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing site. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Site ID. + # @param [Google::Apis::DfareportingV2_7::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.response_class = Google::Apis::DfareportingV2_7::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing site. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV2_7::Site::Representation + command.response_class = Google::Apis::DfareportingV2_7::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one size by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Size ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Size] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Size::Representation + command.response_class = Google::Apis::DfareportingV2_7::Size + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new size. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Size] size_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Size] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/sizes', options) + command.request_representation = Google::Apis::DfareportingV2_7::Size::Representation + command.request_object = size_object + command.response_representation = Google::Apis::DfareportingV2_7::Size::Representation + command.response_class = Google::Apis::DfareportingV2_7::Size + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of sizes, possibly filtered. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Fixnum] height + # Select only sizes with this height. + # @param [Boolean] iab_standard + # Select only IAB standard sizes. + # @param [Array, String] ids + # Select only sizes with these IDs. + # @param [Fixnum] width + # Select only sizes with this width. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::SizesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::SizesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sizes', options) + command.response_representation = Google::Apis::DfareportingV2_7::SizesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::SizesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['height'] = height unless height.nil? + command.query['iabStandard'] = iab_standard unless iab_standard.nil? + command.query['ids'] = ids unless ids.nil? + command.query['width'] = width unless width.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one subaccount by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Subaccount ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV2_7::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new subaccount. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV2_7::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of subaccounts, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Select only subaccounts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "subaccount*2015" will return objects with names like "subaccount + # June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "subaccount" will match objects with + # name "my subaccount", "subaccount 2015", or simply "subaccount". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::SubaccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::SubaccountsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options) + command.response_representation = Google::Apis::DfareportingV2_7::SubaccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::SubaccountsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing subaccount. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Subaccount ID. + # @param [Google::Apis::DfareportingV2_7::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV2_7::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing subaccount. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV2_7::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV2_7::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetableRemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetableRemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::TargetableRemarketingList::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetableRemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of targetable remarketing lists, possibly filtered. This + # method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only targetable remarketing lists targetable by these advertisers. + # @param [Boolean] active + # Select only active or only inactive targetable remarketing lists. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] name + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "remarketing list*2015" will return objects with names like " + # remarketing list June 2015", "remarketing list April 2015", or simply " + # remarketing list 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # remarketing list" will match objects with name "my remarketing list", " + # remarketing list 2015", or simply "remarketing list". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetableRemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetableRemarketingListsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options) + command.response_representation = Google::Apis::DfareportingV2_7::TargetableRemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetableRemarketingListsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['name'] = name unless name.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one targeting template by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Targeting template ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_targeting_template(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new targeting template. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of targeting templates, optionally filtered. This method + # supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] advertiser_id + # Select only targeting templates with this advertiser ID. + # @param [Array, String] ids + # Select only targeting templates with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "template*2015" will return objects with names like "template June + # 2015", "template April 2015", or simply "template 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "template" will match objects with name "my + # template", "template 2015", or simply "template". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetingTemplatesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetingTemplatesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_targeting_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options) + command.response_representation = Google::Apis::DfareportingV2_7::TargetingTemplatesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetingTemplatesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing targeting template. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # Targeting template ID. + # @param [Google::Apis::DfareportingV2_7::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing targeting template. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV2_7::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV2_7::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user profile by ID. + # @param [String] profile_id + # The user profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_profile(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserProfile::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of user profiles for a user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserProfileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserProfileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserProfileList::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserProfileList + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role permission group by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User role permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRolePermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRolePermissionGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRolePermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRolePermissionGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of all supported user role permission groups. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRolePermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRolePermissionGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRolePermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRolePermissionGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role permission by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User role permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRolePermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRolePermission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRolePermission::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRolePermission + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of user role permissions, possibly filtered. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Array, String] ids + # Select only user role permissions with these IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRolePermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRolePermissionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRolePermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRolePermissionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing user role. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/userRoles/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new user role. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of user roles, possibly filtered. This method supports paging. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Boolean] account_user_role_only + # Select only account level user roles not associated with any specific + # subaccount. + # @param [Array, String] ids + # Select only user roles with the specified IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "userrole*2015" will return objects with names like "userrole June + # 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "userrole" will match objects with name "my + # userrole", "userrole 2015", or simply "userrole". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results, default is ASCENDING. + # @param [String] subaccount_id + # Select only user roles that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRolesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRolesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options) + command.response_representation = Google::Apis::DfareportingV2_7::UserRolesListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRolesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['accountUserRoleOnly'] = account_user_role_only unless account_user_role_only.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing user role. This method supports patch semantics. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] id + # User role ID. + # @param [Google::Apis::DfareportingV2_7::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing user role. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV2_7::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV2_7::UserRole::Representation + command.response_class = Google::Apis::DfareportingV2_7::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one video format by ID. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Video format ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::VideoFormat] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::VideoFormat] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_video_format(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats/{id}', options) + command.response_representation = Google::Apis::DfareportingV2_7::VideoFormat::Representation + command.response_class = Google::Apis::DfareportingV2_7::VideoFormat + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists available video formats. + # @param [String] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV2_7::VideoFormatsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV2_7::VideoFormatsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options) + command.response_representation = Google::Apis::DfareportingV2_7::VideoFormatsListResponse::Representation + command.response_class = Google::Apis::DfareportingV2_7::VideoFormatsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + end + end + end + end +end diff --git a/generated/google/apis/dns_v1.rb b/generated/google/apis/dns_v1.rb index b0f582393..7f0fa522b 100644 --- a/generated/google/apis/dns_v1.rb +++ b/generated/google/apis/dns_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/cloud-dns module DnsV1 VERSION = 'V1' - REVISION = '20170102' + REVISION = '20170118' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dns_v2beta1.rb b/generated/google/apis/dns_v2beta1.rb index fca9d8d0f..cc6a55d80 100644 --- a/generated/google/apis/dns_v2beta1.rb +++ b/generated/google/apis/dns_v2beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/cloud-dns module DnsV2beta1 VERSION = 'V2beta1' - REVISION = '20170102' + REVISION = '20170118' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/games_configuration_v1configuration.rb b/generated/google/apis/games_configuration_v1configuration.rb index c29f3cee6..96e52da74 100644 --- a/generated/google/apis/games_configuration_v1configuration.rb +++ b/generated/google/apis/games_configuration_v1configuration.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesConfigurationV1configuration VERSION = 'V1configuration' - REVISION = '20170111' + REVISION = '20170119' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/games_management_v1management.rb b/generated/google/apis/games_management_v1management.rb index b87bbbb14..840148668 100644 --- a/generated/google/apis/games_management_v1management.rb +++ b/generated/google/apis/games_management_v1management.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesManagementV1management VERSION = 'V1management' - REVISION = '20170111' + REVISION = '20170119' # Share your Google+ profile information and view and manage your game activity AUTH_GAMES = 'https://www.googleapis.com/auth/games' diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index feb7baa9f..7a386abaa 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/ module GamesV1 VERSION = 'V1' - REVISION = '20170111' + REVISION = '20170119' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' diff --git a/generated/google/apis/logging_v2beta1/classes.rb b/generated/google/apis/logging_v2beta1/classes.rb index 085ab1e21..9aad362ed 100644 --- a/generated/google/apis/logging_v2beta1/classes.rb +++ b/generated/google/apis/logging_v2beta1/classes.rb @@ -22,568 +22,25 @@ module Google module Apis module LoggingV2beta1 - # Result returned from ListLogMetrics. - class ListLogMetricsResponse - include Google::Apis::Core::Hashable - - # A list of logs-based metrics. - # Corresponds to the JSON property `metrics` - # @return [Array] - attr_accessor :metrics - - # If there might be more results than appear in this response, then - # nextPageToken is included. To get the next set of results, call this method - # again using the value of nextPageToken as pageToken. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @metrics = args[:metrics] if args.key?(:metrics) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # A generic empty message that you can re-use to avoid defining duplicated empty - # messages in your APIs. A typical example is to use it as the request or the - # response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for Empty is empty JSON object ``. - class Empty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # An individual entry in a log. - class LogEntry - include Google::Apis::Core::Hashable - - # Optional. The time the event described by the log entry occurred. If omitted, - # Stackdriver Logging will use the time the log entry is received. - # Corresponds to the JSON property `timestamp` - # @return [String] - attr_accessor :timestamp - - # Required. The resource name of the log to which this log entry belongs: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded within log_name. Example: "organizations/ - # 1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must - # be less than 512 characters long and can only include the following characters: - # upper and lower case alphanumeric characters, forward-slash, underscore, - # hyphen, and period.For backward compatibility, if log_name begins with a - # forward-slash, such as /projects/..., then the log entry is ingested as usual - # but the forward-slash is removed. Listing the log entry will not show the - # leading slash and filtering for a log name with a leading slash will never - # return any results. - # Corresponds to the JSON property `logName` - # @return [String] - attr_accessor :log_name - - # A common proto for logging HTTP requests. Only contains semantics defined by - # the HTTP specification. Product-specific logging information MUST be defined - # in a separate message. - # Corresponds to the JSON property `httpRequest` - # @return [Google::Apis::LoggingV2beta1::HttpRequest] - attr_accessor :http_request - - # An object representing a resource that can be used for monitoring, logging, - # billing, or other purposes. Examples include virtual machine instances, - # databases, and storage devices such as disks. The type field identifies a - # MonitoredResourceDescriptor object that describes the resource's schema. - # Information in the labels field identifies the actual resource and its - # attributes according to the schema. For example, a particular Compute Engine - # VM instance could be represented by the following object, because the - # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " - # zone": - # ` "type": "gce_instance", - # "labels": ` "instance_id": "12345678901234", - # "zone": "us-central1-a" `` - # Corresponds to the JSON property `resource` - # @return [Google::Apis::LoggingV2beta1::MonitoredResource] - attr_accessor :resource - - # The log entry payload, represented as a structure that is expressed as a JSON - # object. - # Corresponds to the JSON property `jsonPayload` - # @return [Hash] - attr_accessor :json_payload - - # Optional. A unique ID for the log entry. If you provide this field, the - # logging service considers other log entries in the same project with the same - # ID as duplicates which can be removed. If omitted, Stackdriver Logging will - # generate a unique ID for this log entry. - # Corresponds to the JSON property `insertId` - # @return [String] - attr_accessor :insert_id - - # Additional information about a potentially long-running operation with which a - # log entry is associated. - # Corresponds to the JSON property `operation` - # @return [Google::Apis::LoggingV2beta1::LogEntryOperation] - attr_accessor :operation - - # The log entry payload, represented as a Unicode string (UTF-8). - # Corresponds to the JSON property `textPayload` - # @return [String] - attr_accessor :text_payload - - # The log entry payload, represented as a protocol buffer. Some Google Cloud - # Platform services use this field for their log entry payloads. - # Corresponds to the JSON property `protoPayload` - # @return [Hash] - attr_accessor :proto_payload - - # Optional. Resource name of the trace associated with the log entry, if any. If - # it contains a relative resource name, the name is assumed to be relative to // - # tracing.googleapis.com. Example: projects/my-projectid/traces/ - # 06796866738c859f2f19b7cfb3214824 - # Corresponds to the JSON property `trace` - # @return [String] - attr_accessor :trace - - # Optional. A set of user-defined (key, value) data that provides additional - # information about the log entry. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # Optional. The severity of the log entry. The default value is LogSeverity. - # DEFAULT. - # Corresponds to the JSON property `severity` - # @return [String] - attr_accessor :severity - - # Additional information about the source code location that produced the log - # entry. - # Corresponds to the JSON property `sourceLocation` - # @return [Google::Apis::LoggingV2beta1::LogEntrySourceLocation] - attr_accessor :source_location - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @timestamp = args[:timestamp] if args.key?(:timestamp) - @log_name = args[:log_name] if args.key?(:log_name) - @http_request = args[:http_request] if args.key?(:http_request) - @resource = args[:resource] if args.key?(:resource) - @json_payload = args[:json_payload] if args.key?(:json_payload) - @insert_id = args[:insert_id] if args.key?(:insert_id) - @operation = args[:operation] if args.key?(:operation) - @text_payload = args[:text_payload] if args.key?(:text_payload) - @proto_payload = args[:proto_payload] if args.key?(:proto_payload) - @trace = args[:trace] if args.key?(:trace) - @labels = args[:labels] if args.key?(:labels) - @severity = args[:severity] if args.key?(:severity) - @source_location = args[:source_location] if args.key?(:source_location) - end - end - - # Specifies a location in a source code file. - class SourceLocation - include Google::Apis::Core::Hashable - - # Line within the source file. - # Corresponds to the JSON property `line` - # @return [String] - attr_accessor :line - - # Source file name. Depending on the runtime environment, this might be a simple - # name or a fully-qualified name. - # Corresponds to the JSON property `file` - # @return [String] - attr_accessor :file - - # Human-readable name of the function or method being invoked, with optional - # context such as the class or package name. This information is used in - # contexts such as the logs viewer, where a file and line number are less - # meaningful. The format can vary by language. For example: qual.if.ied.Class. - # method (Java), dir/package.func (Go), function (Python). - # Corresponds to the JSON property `functionName` - # @return [String] - attr_accessor :function_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @line = args[:line] if args.key?(:line) - @file = args[:file] if args.key?(:file) - @function_name = args[:function_name] if args.key?(:function_name) - end - end - - # The parameters to ListLogEntries. - class ListLogEntriesRequest - include Google::Apis::Core::Hashable - - # Deprecated. Use resource_names instead. One or more project identifiers or - # project numbers from which to retrieve log entries. Example: "my-project-1A". - # If present, these project identifiers are converted to resource name format - # and added to the list of resources in resource_names. - # Corresponds to the JSON property `projectIds` - # @return [Array] - attr_accessor :project_ids - - # Optional. A filter that chooses which log entries to return. See Advanced Logs - # Filters. Only log entries that match the filter are returned. An empty filter - # matches all log entries in the resources listed in resource_names. Referencing - # a parent resource that is not listed in resource_names will cause the filter - # to return no results. The maximum length of the filter is 20000 characters. - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - - # Optional. If present, then retrieve the next batch of results from the - # preceding call to this method. pageToken must be the value of nextPageToken - # from the previous response. The values of other method parameters should be - # identical to those in the previous call. - # Corresponds to the JSON property `pageToken` - # @return [String] - attr_accessor :page_token - - # Optional. The maximum number of results to return from this request. Non- - # positive values are ignored. The presence of nextPageToken in the response - # indicates that more results might be available. - # Corresponds to the JSON property `pageSize` - # @return [Fixnum] - attr_accessor :page_size - - # Optional. How the results should be sorted. Presently, the only permitted - # values are "timestamp asc" (default) and "timestamp desc". The first option - # returns entries in order of increasing values of LogEntry.timestamp (oldest - # first), and the second option returns entries in order of decreasing - # timestamps (newest first). Entries with equal timestamps are returned in order - # of LogEntry.insertId. - # Corresponds to the JSON property `orderBy` - # @return [String] - attr_accessor :order_by - - # Required. Names of one or more resources from which to retrieve log entries: - # "projects/[PROJECT_ID]" - # "organizations/[ORGANIZATION_ID]" - # Projects listed in the project_ids field are added to this list. - # Corresponds to the JSON property `resourceNames` - # @return [Array] - attr_accessor :resource_names - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @project_ids = args[:project_ids] if args.key?(:project_ids) - @filter = args[:filter] if args.key?(:filter) - @page_token = args[:page_token] if args.key?(:page_token) - @page_size = args[:page_size] if args.key?(:page_size) - @order_by = args[:order_by] if args.key?(:order_by) - @resource_names = args[:resource_names] if args.key?(:resource_names) - end - end - - # Complete log information about a single HTTP request to an App Engine - # application. - class RequestLog - include Google::Apis::Core::Hashable - - # The logged-in user who made the request.Most likely, this is the part of the - # user's email before the @ sign. The field value is the same for different - # requests from the same user, but different users can have similar names. This - # information is also available to the application via the App Engine Users API. - # This field will be populated starting with App Engine 1.9.21. - # Corresponds to the JSON property `nickname` - # @return [String] - attr_accessor :nickname - - # HTTP response status code. Example: 200, 404. - # Corresponds to the JSON property `status` - # @return [Fixnum] - attr_accessor :status - - # Contains the path and query portion of the URL that was requested. For example, - # if the URL was "http://example.com/app?name=val", the resource would be "/app? - # name=val". The fragment identifier, which is identified by the # character, is - # not included. - # Corresponds to the JSON property `resource` - # @return [String] - attr_accessor :resource - - # Time this request spent in the pending request queue. - # Corresponds to the JSON property `pendingTime` - # @return [String] - attr_accessor :pending_time - - # Task name of the request, in the case of an offline request. - # Corresponds to the JSON property `taskName` - # @return [String] - attr_accessor :task_name - - # File or class that handled the request. - # Corresponds to the JSON property `urlMapEntry` - # @return [String] - attr_accessor :url_map_entry - - # If the instance processing this request belongs to a manually scaled module, - # then this is the 0-based index of the instance. Otherwise, this value is -1. - # Corresponds to the JSON property `instanceIndex` - # @return [Fixnum] - attr_accessor :instance_index - - # Internet host and port number of the resource being requested. - # Corresponds to the JSON property `host` - # @return [String] - attr_accessor :host - - # Whether this request is finished or active. - # Corresponds to the JSON property `finished` - # @return [Boolean] - attr_accessor :finished - alias_method :finished?, :finished - - # HTTP version of request. Example: "HTTP/1.1". - # Corresponds to the JSON property `httpVersion` - # @return [String] - attr_accessor :http_version - - # Time when the request started. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Latency of the request. - # Corresponds to the JSON property `latency` - # @return [String] - attr_accessor :latency - - # Origin IP address. - # Corresponds to the JSON property `ip` - # @return [String] - attr_accessor :ip - - # Application that handled this request. - # Corresponds to the JSON property `appId` - # @return [String] - attr_accessor :app_id - - # App Engine release version. - # Corresponds to the JSON property `appEngineRelease` - # @return [String] - attr_accessor :app_engine_release - - # Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # An indication of the relative cost of serving this request. - # Corresponds to the JSON property `cost` - # @return [Float] - attr_accessor :cost - - # An identifier for the instance that handled the request. - # Corresponds to the JSON property `instanceId` - # @return [String] - attr_accessor :instance_id - - # Number of CPU megacycles used to process request. - # Corresponds to the JSON property `megaCycles` - # @return [String] - attr_accessor :mega_cycles - - # Whether this is the first RequestLog entry for this request. If an active - # request has several RequestLog entries written to Stackdriver Logging, then - # this field will be set for one of them. - # Corresponds to the JSON property `first` - # @return [Boolean] - attr_accessor :first - alias_method :first?, :first - - # Version of the application that handled this request. - # Corresponds to the JSON property `versionId` - # @return [String] - attr_accessor :version_id - - # Module of the application that handled this request. - # Corresponds to the JSON property `moduleId` - # @return [String] - attr_accessor :module_id - - # Time when the request finished. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # User agent that made the request. - # Corresponds to the JSON property `userAgent` - # @return [String] - attr_accessor :user_agent - - # Whether this was a loading request for the instance. - # Corresponds to the JSON property `wasLoadingRequest` - # @return [Boolean] - attr_accessor :was_loading_request - alias_method :was_loading_request?, :was_loading_request - - # Source code for the application that handled this request. There can be more - # than one source reference per deployed application if source code is - # distributed among multiple repositories. - # Corresponds to the JSON property `sourceReference` - # @return [Array] - attr_accessor :source_reference - - # Size in bytes sent back to client by request. - # Corresponds to the JSON property `responseSize` - # @return [String] - attr_accessor :response_size - - # Stackdriver Trace identifier for this request. - # Corresponds to the JSON property `traceId` - # @return [String] - attr_accessor :trace_id - - # A list of log lines emitted by the application while serving this request. - # Corresponds to the JSON property `line` - # @return [Array] - attr_accessor :line - - # Queue name of the request, in the case of an offline request. - # Corresponds to the JSON property `taskQueueName` - # @return [String] - attr_accessor :task_queue_name - - # Referrer URL of request. - # Corresponds to the JSON property `referrer` - # @return [String] - attr_accessor :referrer - - # Globally unique identifier for a request, which is based on the request start - # time. Request IDs for requests which started later will compare greater as - # strings than those for requests which started earlier. - # Corresponds to the JSON property `requestId` - # @return [String] - attr_accessor :request_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @nickname = args[:nickname] if args.key?(:nickname) - @status = args[:status] if args.key?(:status) - @resource = args[:resource] if args.key?(:resource) - @pending_time = args[:pending_time] if args.key?(:pending_time) - @task_name = args[:task_name] if args.key?(:task_name) - @url_map_entry = args[:url_map_entry] if args.key?(:url_map_entry) - @instance_index = args[:instance_index] if args.key?(:instance_index) - @host = args[:host] if args.key?(:host) - @finished = args[:finished] if args.key?(:finished) - @http_version = args[:http_version] if args.key?(:http_version) - @start_time = args[:start_time] if args.key?(:start_time) - @latency = args[:latency] if args.key?(:latency) - @ip = args[:ip] if args.key?(:ip) - @app_id = args[:app_id] if args.key?(:app_id) - @app_engine_release = args[:app_engine_release] if args.key?(:app_engine_release) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @cost = args[:cost] if args.key?(:cost) - @instance_id = args[:instance_id] if args.key?(:instance_id) - @mega_cycles = args[:mega_cycles] if args.key?(:mega_cycles) - @first = args[:first] if args.key?(:first) - @version_id = args[:version_id] if args.key?(:version_id) - @module_id = args[:module_id] if args.key?(:module_id) - @end_time = args[:end_time] if args.key?(:end_time) - @user_agent = args[:user_agent] if args.key?(:user_agent) - @was_loading_request = args[:was_loading_request] if args.key?(:was_loading_request) - @source_reference = args[:source_reference] if args.key?(:source_reference) - @response_size = args[:response_size] if args.key?(:response_size) - @trace_id = args[:trace_id] if args.key?(:trace_id) - @line = args[:line] if args.key?(:line) - @task_queue_name = args[:task_queue_name] if args.key?(:task_queue_name) - @referrer = args[:referrer] if args.key?(:referrer) - @request_id = args[:request_id] if args.key?(:request_id) - end - end - - # Result returned from ListMonitoredResourceDescriptors. - class ListMonitoredResourceDescriptorsResponse - include Google::Apis::Core::Hashable - - # If there might be more results than those appearing in this response, then - # nextPageToken is included. To get the next set of results, call this method - # again using the value of nextPageToken as pageToken. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of resource descriptors. - # Corresponds to the JSON property `resourceDescriptors` - # @return [Array] - attr_accessor :resource_descriptors - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @resource_descriptors = args[:resource_descriptors] if args.key?(:resource_descriptors) - end - end - - # A reference to a particular snapshot of the source tree used to build and - # deploy an application. - class SourceReference - include Google::Apis::Core::Hashable - - # Optional. A URI string identifying the repository. Example: "https://github. - # com/GoogleCloudPlatform/kubernetes.git" - # Corresponds to the JSON property `repository` - # @return [String] - attr_accessor :repository - - # The canonical and persistent identifier of the deployed revision. Example (git) - # : "0035781c50ec7aa23385dc841529ce8a4b70db1b" - # Corresponds to the JSON property `revisionId` - # @return [String] - attr_accessor :revision_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @repository = args[:repository] if args.key?(:repository) - @revision_id = args[:revision_id] if args.key?(:revision_id) - end - end - # Describes a logs-based metric. The value of the metric is the number of log # entries that match a logs filter in a given time interval. class LogMetric include Google::Apis::Core::Hashable + # Output only. The API version that created or updated this metric. The version + # also dictates the syntax of the filter expression. When a value for this field + # is missing, the default value of V2 should be assumed. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + # Required. An advanced logs filter which is used to match log entries. Example: + # "resource.type=gae_app AND severity>=ERROR" + # The maximum length of the filter is 20000 characters. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + # Required. The client-assigned metric identifier. Examples: "error_count", " # nginx/requests".Metric identifiers are limited to 100 characters and can # include only the following characters: A-Z, a-z, 0-9, and the special @@ -602,30 +59,16 @@ module Google # @return [String] attr_accessor :description - # Output only. The API version that created or updated this metric. The version - # also dictates the syntax of the filter expression. When a value for this field - # is missing, the default value of V2 should be assumed. - # Corresponds to the JSON property `version` - # @return [String] - attr_accessor :version - - # Required. An advanced logs filter which is used to match log entries. Example: - # "resource.type=gae_app AND severity>=ERROR" - # The maximum length of the filter is 20000 characters. - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @name = args[:name] if args.key?(:name) - @description = args[:description] if args.key?(:description) @version = args[:version] if args.key?(:version) @filter = args[:filter] if args.key?(:filter) + @name = args[:name] if args.key?(:name) + @description = args[:description] if args.key?(:description) end end @@ -732,6 +175,26 @@ module Google class LogSink include Google::Apis::Core::Hashable + # Output only. An IAM identity—a service account or group—under + # which Stackdriver Logging writes the exported log entries to the sink's + # destination. This field is set by sinks.create and sinks.update, based on the + # setting of unique_writer_identity in those methods.Until you grant this + # identity write-access to the destination, log entry exports from this sink + # will fail. For more information, see Granting access for a resource. Consult + # the destination service's documentation to determine the appropriate IAM roles + # to assign to the identity. + # Corresponds to the JSON property `writerIdentity` + # @return [String] + attr_accessor :writer_identity + + # Optional. The time at which this sink will begin exporting log entries. Log + # entries are exported only if their timestamp is not earlier than the start + # time. The default value of this field is the time the sink is created or + # updated. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + # Optional. The log entry format to use for this sink's exported log entries. # The v2 format is used by default. The v1 format is deprecated and should be # used only as part of a migration effort to v2. See Migration to the v2 API. @@ -747,6 +210,15 @@ module Google # @return [String] attr_accessor :name + # Optional. An advanced logs filter. The only exported log entries are those + # that are in the resource owning the sink and that match the filter. The filter + # must use the log entry format specified by the output_version_format parameter. + # For example, in the v2 format: + # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + # Required. The export destination: # "storage.googleapis.com/[GCS_BUCKET]" # "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" @@ -758,15 +230,6 @@ module Google # @return [String] attr_accessor :destination - # Optional. An advanced logs filter. The only exported log entries are those - # that are in the resource owning the sink and that match the filter. The filter - # must use the log entry format specified by the output_version_format parameter. - # For example, in the v2 format: - # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - # Optional. The time at which this sink will stop exporting log entries. Log # entries are exported only if their timestamp is earlier than the end time. If # this field is not supplied, there is no end time. If both a start time and an @@ -775,39 +238,19 @@ module Google # @return [String] attr_accessor :end_time - # Optional. The time at which this sink will begin exporting log entries. Log - # entries are exported only if their timestamp is not earlier than the start - # time. The default value of this field is the time the sink is created or - # updated. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Output only. An IAM identity—a service account or group—under - # which Stackdriver Logging writes the exported log entries to the sink's - # destination. This field is set by sinks.create and sinks.update, based on the - # setting of unique_writer_identity in those methods.Until you grant this - # identity write-access to the destination, log entry exports from this sink - # will fail. For more information, see Granting access for a resource. Consult - # the destination service's documentation to determine the appropriate IAM roles - # to assign to the identity. - # Corresponds to the JSON property `writerIdentity` - # @return [String] - attr_accessor :writer_identity - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @writer_identity = args[:writer_identity] if args.key?(:writer_identity) + @start_time = args[:start_time] if args.key?(:start_time) @output_version_format = args[:output_version_format] if args.key?(:output_version_format) @name = args[:name] if args.key?(:name) - @destination = args[:destination] if args.key?(:destination) @filter = args[:filter] if args.key?(:filter) + @destination = args[:destination] if args.key?(:destination) @end_time = args[:end_time] if args.key?(:end_time) - @start_time = args[:start_time] if args.key?(:start_time) - @writer_identity = args[:writer_identity] if args.key?(:writer_identity) end end @@ -815,6 +258,29 @@ module Google class WriteLogEntriesRequest include Google::Apis::Core::Hashable + # Optional. Default labels that are added to the labels field of all log entries + # in entries. If a log entry already has a label with the same key as a label in + # this parameter, then the log entry's label is not changed. See LogEntry. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # An object representing a resource that can be used for monitoring, logging, + # billing, or other purposes. Examples include virtual machine instances, + # databases, and storage devices such as disks. The type field identifies a + # MonitoredResourceDescriptor object that describes the resource's schema. + # Information in the labels field identifies the actual resource and its + # attributes according to the schema. For example, a particular Compute Engine + # VM instance could be represented by the following object, because the + # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " + # zone": + # ` "type": "gce_instance", + # "labels": ` "instance_id": "12345678901234", + # "zone": "us-central1-a" `` + # Corresponds to the JSON property `resource` + # @return [Google::Apis::LoggingV2beta1::MonitoredResource] + attr_accessor :resource + # Optional. A default log resource name that is assigned to all log entries in # entries that do not specify a value for log_name: # "projects/[PROJECT_ID]/logs/[LOG_ID]" @@ -846,40 +312,17 @@ module Google attr_accessor :partial_success alias_method :partial_success?, :partial_success - # Optional. Default labels that are added to the labels field of all log entries - # in entries. If a log entry already has a label with the same key as a label in - # this parameter, then the log entry's label is not changed. See LogEntry. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # An object representing a resource that can be used for monitoring, logging, - # billing, or other purposes. Examples include virtual machine instances, - # databases, and storage devices such as disks. The type field identifies a - # MonitoredResourceDescriptor object that describes the resource's schema. - # Information in the labels field identifies the actual resource and its - # attributes according to the schema. For example, a particular Compute Engine - # VM instance could be represented by the following object, because the - # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " - # zone": - # ` "type": "gce_instance", - # "labels": ` "instance_id": "12345678901234", - # "zone": "us-central1-a" `` - # Corresponds to the JSON property `resource` - # @return [Google::Apis::LoggingV2beta1::MonitoredResource] - attr_accessor :resource - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @resource = args[:resource] if args.key?(:resource) @log_name = args[:log_name] if args.key?(:log_name) @entries = args[:entries] if args.key?(:entries) @partial_success = args[:partial_success] if args.key?(:partial_success) - @labels = args[:labels] if args.key?(:labels) - @resource = args[:resource] if args.key?(:resource) end end @@ -911,69 +354,12 @@ module Google end end - # Result returned from ListSinks. - class ListSinksResponse - include Google::Apis::Core::Hashable - - # A list of sinks. - # Corresponds to the JSON property `sinks` - # @return [Array] - attr_accessor :sinks - - # If there might be more results than appear in this response, then - # nextPageToken is included. To get the next set of results, call the same - # method again using the value of nextPageToken as pageToken. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sinks = args[:sinks] if args.key?(:sinks) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # A common proto for logging HTTP requests. Only contains semantics defined by # the HTTP specification. Product-specific logging information MUST be defined # in a separate message. class HttpRequest include Google::Apis::Core::Hashable - # The size of the HTTP request message in bytes, including the request headers - # and the request body. - # Corresponds to the JSON property `requestSize` - # @return [String] - attr_accessor :request_size - - # The size of the HTTP response message sent back to the client, in bytes, - # including the response headers and the response body. - # Corresponds to the JSON property `responseSize` - # @return [String] - attr_accessor :response_size - - # The scheme (http, https), the host name, the path and the query portion of the - # URL that was requested. Example: "http://example.com/some/info?color=red". - # Corresponds to the JSON property `requestUrl` - # @return [String] - attr_accessor :request_url - - # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. - # Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". - # Corresponds to the JSON property `remoteIp` - # @return [String] - attr_accessor :remote_ip - - # The IP address (IPv4 or IPv6) of the origin server that the request was sent - # to. - # Corresponds to the JSON property `serverIp` - # @return [String] - attr_accessor :server_ip - # Whether or not a cache lookup was attempted. # Corresponds to the JSON property `cacheLookup` # @return [Boolean] @@ -1027,17 +413,42 @@ module Google # @return [String] attr_accessor :request_method + # The size of the HTTP response message sent back to the client, in bytes, + # including the response headers and the response body. + # Corresponds to the JSON property `responseSize` + # @return [String] + attr_accessor :response_size + + # The size of the HTTP request message in bytes, including the request headers + # and the request body. + # Corresponds to the JSON property `requestSize` + # @return [String] + attr_accessor :request_size + + # The scheme (http, https), the host name, the path and the query portion of the + # URL that was requested. Example: "http://example.com/some/info?color=red". + # Corresponds to the JSON property `requestUrl` + # @return [String] + attr_accessor :request_url + + # The IP address (IPv4 or IPv6) of the origin server that the request was sent + # to. + # Corresponds to the JSON property `serverIp` + # @return [String] + attr_accessor :server_ip + + # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. + # Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". + # Corresponds to the JSON property `remoteIp` + # @return [String] + attr_accessor :remote_ip + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @request_size = args[:request_size] if args.key?(:request_size) - @response_size = args[:response_size] if args.key?(:response_size) - @request_url = args[:request_url] if args.key?(:request_url) - @remote_ip = args[:remote_ip] if args.key?(:remote_ip) - @server_ip = args[:server_ip] if args.key?(:server_ip) @cache_lookup = args[:cache_lookup] if args.key?(:cache_lookup) @cache_hit = args[:cache_hit] if args.key?(:cache_hit) @cache_validated_with_origin_server = args[:cache_validated_with_origin_server] if args.key?(:cache_validated_with_origin_server) @@ -1047,6 +458,38 @@ module Google @user_agent = args[:user_agent] if args.key?(:user_agent) @cache_fill_bytes = args[:cache_fill_bytes] if args.key?(:cache_fill_bytes) @request_method = args[:request_method] if args.key?(:request_method) + @response_size = args[:response_size] if args.key?(:response_size) + @request_size = args[:request_size] if args.key?(:request_size) + @request_url = args[:request_url] if args.key?(:request_url) + @server_ip = args[:server_ip] if args.key?(:server_ip) + @remote_ip = args[:remote_ip] if args.key?(:remote_ip) + end + end + + # Result returned from ListSinks. + class ListSinksResponse + include Google::Apis::Core::Hashable + + # If there might be more results than appear in this response, then + # nextPageToken is included. To get the next set of results, call the same + # method again using the value of nextPageToken as pageToken. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of sinks. + # Corresponds to the JSON property `sinks` + # @return [Array] + attr_accessor :sinks + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @sinks = args[:sinks] if args.key?(:sinks) end end @@ -1054,6 +497,11 @@ module Google class LabelDescriptor include Google::Apis::Core::Hashable + # The label key. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + # A human-readable description for the label. # Corresponds to the JSON property `description` # @return [String] @@ -1064,20 +512,15 @@ module Google # @return [String] attr_accessor :value_type - # The label key. - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @key = args[:key] if args.key?(:key) @description = args[:description] if args.key?(:description) @value_type = args[:value_type] if args.key?(:value_type) - @key = args[:key] if args.key?(:key) end end @@ -1091,20 +534,6 @@ module Google class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Required. The monitored resource type. For example, the type " - # cloudsql_database" represents databases in Google Cloud SQL. The maximum - # length of this value is 256 characters. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Required. A set of labels used to describe instances of this monitored - # resource type. For example, an individual Google Cloud SQL database is - # identified by values for the labels "database_id" and "zone". - # Corresponds to the JSON property `labels` - # @return [Array] - attr_accessor :labels - # Optional. The resource name of the monitored resource descriptor: "projects/` # project_id`/monitoredResourceDescriptors/`type`" where `type` is the value of # the type field in this object and `project_id` is a project ID that provides @@ -1128,17 +557,31 @@ module Google # @return [String] attr_accessor :description + # Required. The monitored resource type. For example, the type " + # cloudsql_database" represents databases in Google Cloud SQL. The maximum + # length of this value is 256 characters. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Required. A set of labels used to describe instances of this monitored + # resource type. For example, an individual Google Cloud SQL database is + # identified by values for the labels "database_id" and "zone". + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @type = args[:type] if args.key?(:type) - @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @display_name = args[:display_name] if args.key?(:display_name) @description = args[:description] if args.key?(:description) + @type = args[:type] if args.key?(:type) + @labels = args[:labels] if args.key?(:labels) end end @@ -1147,6 +590,12 @@ module Google class LogEntrySourceLocation include Google::Apis::Core::Hashable + # Optional. Line within the source file. 1-based; 0 indicates no line number + # available. + # Corresponds to the JSON property `line` + # @return [String] + attr_accessor :line + # Optional. Source file name. Depending on the runtime environment, this might # be a simple name or a fully-qualified name. # Corresponds to the JSON property `file` @@ -1162,21 +611,15 @@ module Google # @return [String] attr_accessor :function - # Optional. Line within the source file. 1-based; 0 indicates no line number - # available. - # Corresponds to the JSON property `line` - # @return [String] - attr_accessor :line - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @line = args[:line] if args.key?(:line) @file = args[:file] if args.key?(:file) @function = args[:function] if args.key?(:function) - @line = args[:line] if args.key?(:line) end end @@ -1249,6 +692,563 @@ module Google @time = args[:time] if args.key?(:time) end end + + # Result returned from ListLogMetrics. + class ListLogMetricsResponse + include Google::Apis::Core::Hashable + + # A list of logs-based metrics. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # If there might be more results than appear in this response, then + # nextPageToken is included. To get the next set of results, call this method + # again using the value of nextPageToken as pageToken. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for Empty is empty JSON object ``. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # An individual entry in a log. + class LogEntry + include Google::Apis::Core::Hashable + + # Optional. A set of user-defined (key, value) data that provides additional + # information about the log entry. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Optional. Resource name of the trace associated with the log entry, if any. If + # it contains a relative resource name, the name is assumed to be relative to // + # tracing.googleapis.com. Example: projects/my-projectid/traces/ + # 06796866738c859f2f19b7cfb3214824 + # Corresponds to the JSON property `trace` + # @return [String] + attr_accessor :trace + + # Optional. The severity of the log entry. The default value is LogSeverity. + # DEFAULT. + # Corresponds to the JSON property `severity` + # @return [String] + attr_accessor :severity + + # Additional information about the source code location that produced the log + # entry. + # Corresponds to the JSON property `sourceLocation` + # @return [Google::Apis::LoggingV2beta1::LogEntrySourceLocation] + attr_accessor :source_location + + # Optional. The time the event described by the log entry occurred. If omitted, + # Stackdriver Logging will use the time the log entry is received. + # Corresponds to the JSON property `timestamp` + # @return [String] + attr_accessor :timestamp + + # Required. The resource name of the log to which this log entry belongs: + # "projects/[PROJECT_ID]/logs/[LOG_ID]" + # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" + # [LOG_ID] must be URL-encoded within log_name. Example: "organizations/ + # 1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must + # be less than 512 characters long and can only include the following characters: + # upper and lower case alphanumeric characters, forward-slash, underscore, + # hyphen, and period.For backward compatibility, if log_name begins with a + # forward-slash, such as /projects/..., then the log entry is ingested as usual + # but the forward-slash is removed. Listing the log entry will not show the + # leading slash and filtering for a log name with a leading slash will never + # return any results. + # Corresponds to the JSON property `logName` + # @return [String] + attr_accessor :log_name + + # A common proto for logging HTTP requests. Only contains semantics defined by + # the HTTP specification. Product-specific logging information MUST be defined + # in a separate message. + # Corresponds to the JSON property `httpRequest` + # @return [Google::Apis::LoggingV2beta1::HttpRequest] + attr_accessor :http_request + + # An object representing a resource that can be used for monitoring, logging, + # billing, or other purposes. Examples include virtual machine instances, + # databases, and storage devices such as disks. The type field identifies a + # MonitoredResourceDescriptor object that describes the resource's schema. + # Information in the labels field identifies the actual resource and its + # attributes according to the schema. For example, a particular Compute Engine + # VM instance could be represented by the following object, because the + # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " + # zone": + # ` "type": "gce_instance", + # "labels": ` "instance_id": "12345678901234", + # "zone": "us-central1-a" `` + # Corresponds to the JSON property `resource` + # @return [Google::Apis::LoggingV2beta1::MonitoredResource] + attr_accessor :resource + + # The log entry payload, represented as a structure that is expressed as a JSON + # object. + # Corresponds to the JSON property `jsonPayload` + # @return [Hash] + attr_accessor :json_payload + + # Additional information about a potentially long-running operation with which a + # log entry is associated. + # Corresponds to the JSON property `operation` + # @return [Google::Apis::LoggingV2beta1::LogEntryOperation] + attr_accessor :operation + + # Optional. A unique ID for the log entry. If you provide this field, the + # logging service considers other log entries in the same project with the same + # ID as duplicates which can be removed. If omitted, Stackdriver Logging will + # generate a unique ID for this log entry. + # Corresponds to the JSON property `insertId` + # @return [String] + attr_accessor :insert_id + + # The log entry payload, represented as a Unicode string (UTF-8). + # Corresponds to the JSON property `textPayload` + # @return [String] + attr_accessor :text_payload + + # The log entry payload, represented as a protocol buffer. Some Google Cloud + # Platform services use this field for their log entry payloads. + # Corresponds to the JSON property `protoPayload` + # @return [Hash] + attr_accessor :proto_payload + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @trace = args[:trace] if args.key?(:trace) + @severity = args[:severity] if args.key?(:severity) + @source_location = args[:source_location] if args.key?(:source_location) + @timestamp = args[:timestamp] if args.key?(:timestamp) + @log_name = args[:log_name] if args.key?(:log_name) + @http_request = args[:http_request] if args.key?(:http_request) + @resource = args[:resource] if args.key?(:resource) + @json_payload = args[:json_payload] if args.key?(:json_payload) + @operation = args[:operation] if args.key?(:operation) + @insert_id = args[:insert_id] if args.key?(:insert_id) + @text_payload = args[:text_payload] if args.key?(:text_payload) + @proto_payload = args[:proto_payload] if args.key?(:proto_payload) + end + end + + # Specifies a location in a source code file. + class SourceLocation + include Google::Apis::Core::Hashable + + # Line within the source file. + # Corresponds to the JSON property `line` + # @return [String] + attr_accessor :line + + # Source file name. Depending on the runtime environment, this might be a simple + # name or a fully-qualified name. + # Corresponds to the JSON property `file` + # @return [String] + attr_accessor :file + + # Human-readable name of the function or method being invoked, with optional + # context such as the class or package name. This information is used in + # contexts such as the logs viewer, where a file and line number are less + # meaningful. The format can vary by language. For example: qual.if.ied.Class. + # method (Java), dir/package.func (Go), function (Python). + # Corresponds to the JSON property `functionName` + # @return [String] + attr_accessor :function_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @line = args[:line] if args.key?(:line) + @file = args[:file] if args.key?(:file) + @function_name = args[:function_name] if args.key?(:function_name) + end + end + + # The parameters to ListLogEntries. + class ListLogEntriesRequest + include Google::Apis::Core::Hashable + + # Optional. How the results should be sorted. Presently, the only permitted + # values are "timestamp asc" (default) and "timestamp desc". The first option + # returns entries in order of increasing values of LogEntry.timestamp (oldest + # first), and the second option returns entries in order of decreasing + # timestamps (newest first). Entries with equal timestamps are returned in order + # of LogEntry.insertId. + # Corresponds to the JSON property `orderBy` + # @return [String] + attr_accessor :order_by + + # Required. Names of one or more resources from which to retrieve log entries: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # Projects listed in the project_ids field are added to this list. + # Corresponds to the JSON property `resourceNames` + # @return [Array] + attr_accessor :resource_names + + # Optional. A filter that chooses which log entries to return. See Advanced Logs + # Filters. Only log entries that match the filter are returned. An empty filter + # matches all log entries in the resources listed in resource_names. Referencing + # a parent resource that is not listed in resource_names will cause the filter + # to return no results. The maximum length of the filter is 20000 characters. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Deprecated. Use resource_names instead. One or more project identifiers or + # project numbers from which to retrieve log entries. Example: "my-project-1A". + # If present, these project identifiers are converted to resource name format + # and added to the list of resources in resource_names. + # Corresponds to the JSON property `projectIds` + # @return [Array] + attr_accessor :project_ids + + # Optional. If present, then retrieve the next batch of results from the + # preceding call to this method. pageToken must be the value of nextPageToken + # from the previous response. The values of other method parameters should be + # identical to those in the previous call. + # Corresponds to the JSON property `pageToken` + # @return [String] + attr_accessor :page_token + + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. The presence of nextPageToken in the response + # indicates that more results might be available. + # Corresponds to the JSON property `pageSize` + # @return [Fixnum] + attr_accessor :page_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @order_by = args[:order_by] if args.key?(:order_by) + @resource_names = args[:resource_names] if args.key?(:resource_names) + @filter = args[:filter] if args.key?(:filter) + @project_ids = args[:project_ids] if args.key?(:project_ids) + @page_token = args[:page_token] if args.key?(:page_token) + @page_size = args[:page_size] if args.key?(:page_size) + end + end + + # Complete log information about a single HTTP request to an App Engine + # application. + class RequestLog + include Google::Apis::Core::Hashable + + # Version of the application that handled this request. + # Corresponds to the JSON property `versionId` + # @return [String] + attr_accessor :version_id + + # Module of the application that handled this request. + # Corresponds to the JSON property `moduleId` + # @return [String] + attr_accessor :module_id + + # Time when the request finished. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # User agent that made the request. + # Corresponds to the JSON property `userAgent` + # @return [String] + attr_accessor :user_agent + + # Whether this was a loading request for the instance. + # Corresponds to the JSON property `wasLoadingRequest` + # @return [Boolean] + attr_accessor :was_loading_request + alias_method :was_loading_request?, :was_loading_request + + # Source code for the application that handled this request. There can be more + # than one source reference per deployed application if source code is + # distributed among multiple repositories. + # Corresponds to the JSON property `sourceReference` + # @return [Array] + attr_accessor :source_reference + + # Size in bytes sent back to client by request. + # Corresponds to the JSON property `responseSize` + # @return [String] + attr_accessor :response_size + + # Stackdriver Trace identifier for this request. + # Corresponds to the JSON property `traceId` + # @return [String] + attr_accessor :trace_id + + # A list of log lines emitted by the application while serving this request. + # Corresponds to the JSON property `line` + # @return [Array] + attr_accessor :line + + # Referrer URL of request. + # Corresponds to the JSON property `referrer` + # @return [String] + attr_accessor :referrer + + # Queue name of the request, in the case of an offline request. + # Corresponds to the JSON property `taskQueueName` + # @return [String] + attr_accessor :task_queue_name + + # Globally unique identifier for a request, which is based on the request start + # time. Request IDs for requests which started later will compare greater as + # strings than those for requests which started earlier. + # Corresponds to the JSON property `requestId` + # @return [String] + attr_accessor :request_id + + # The logged-in user who made the request.Most likely, this is the part of the + # user's email before the @ sign. The field value is the same for different + # requests from the same user, but different users can have similar names. This + # information is also available to the application via the App Engine Users API. + # This field will be populated starting with App Engine 1.9.21. + # Corresponds to the JSON property `nickname` + # @return [String] + attr_accessor :nickname + + # Contains the path and query portion of the URL that was requested. For example, + # if the URL was "http://example.com/app?name=val", the resource would be "/app? + # name=val". The fragment identifier, which is identified by the # character, is + # not included. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + # Time this request spent in the pending request queue. + # Corresponds to the JSON property `pendingTime` + # @return [String] + attr_accessor :pending_time + + # HTTP response status code. Example: 200, 404. + # Corresponds to the JSON property `status` + # @return [Fixnum] + attr_accessor :status + + # Task name of the request, in the case of an offline request. + # Corresponds to the JSON property `taskName` + # @return [String] + attr_accessor :task_name + + # File or class that handled the request. + # Corresponds to the JSON property `urlMapEntry` + # @return [String] + attr_accessor :url_map_entry + + # If the instance processing this request belongs to a manually scaled module, + # then this is the 0-based index of the instance. Otherwise, this value is -1. + # Corresponds to the JSON property `instanceIndex` + # @return [Fixnum] + attr_accessor :instance_index + + # Internet host and port number of the resource being requested. + # Corresponds to the JSON property `host` + # @return [String] + attr_accessor :host + + # Whether this request is finished or active. + # Corresponds to the JSON property `finished` + # @return [Boolean] + attr_accessor :finished + alias_method :finished?, :finished + + # HTTP version of request. Example: "HTTP/1.1". + # Corresponds to the JSON property `httpVersion` + # @return [String] + attr_accessor :http_version + + # Time when the request started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Latency of the request. + # Corresponds to the JSON property `latency` + # @return [String] + attr_accessor :latency + + # Origin IP address. + # Corresponds to the JSON property `ip` + # @return [String] + attr_accessor :ip + + # Application that handled this request. + # Corresponds to the JSON property `appId` + # @return [String] + attr_accessor :app_id + + # App Engine release version. + # Corresponds to the JSON property `appEngineRelease` + # @return [String] + attr_accessor :app_engine_release + + # Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". + # Corresponds to the JSON property `method` + # @return [String] + attr_accessor :method_prop + + # An indication of the relative cost of serving this request. + # Corresponds to the JSON property `cost` + # @return [Float] + attr_accessor :cost + + # An identifier for the instance that handled the request. + # Corresponds to the JSON property `instanceId` + # @return [String] + attr_accessor :instance_id + + # Number of CPU megacycles used to process request. + # Corresponds to the JSON property `megaCycles` + # @return [String] + attr_accessor :mega_cycles + + # Whether this is the first RequestLog entry for this request. If an active + # request has several RequestLog entries written to Stackdriver Logging, then + # this field will be set for one of them. + # Corresponds to the JSON property `first` + # @return [Boolean] + attr_accessor :first + alias_method :first?, :first + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version_id = args[:version_id] if args.key?(:version_id) + @module_id = args[:module_id] if args.key?(:module_id) + @end_time = args[:end_time] if args.key?(:end_time) + @user_agent = args[:user_agent] if args.key?(:user_agent) + @was_loading_request = args[:was_loading_request] if args.key?(:was_loading_request) + @source_reference = args[:source_reference] if args.key?(:source_reference) + @response_size = args[:response_size] if args.key?(:response_size) + @trace_id = args[:trace_id] if args.key?(:trace_id) + @line = args[:line] if args.key?(:line) + @referrer = args[:referrer] if args.key?(:referrer) + @task_queue_name = args[:task_queue_name] if args.key?(:task_queue_name) + @request_id = args[:request_id] if args.key?(:request_id) + @nickname = args[:nickname] if args.key?(:nickname) + @resource = args[:resource] if args.key?(:resource) + @pending_time = args[:pending_time] if args.key?(:pending_time) + @status = args[:status] if args.key?(:status) + @task_name = args[:task_name] if args.key?(:task_name) + @url_map_entry = args[:url_map_entry] if args.key?(:url_map_entry) + @instance_index = args[:instance_index] if args.key?(:instance_index) + @host = args[:host] if args.key?(:host) + @finished = args[:finished] if args.key?(:finished) + @http_version = args[:http_version] if args.key?(:http_version) + @start_time = args[:start_time] if args.key?(:start_time) + @latency = args[:latency] if args.key?(:latency) + @ip = args[:ip] if args.key?(:ip) + @app_id = args[:app_id] if args.key?(:app_id) + @app_engine_release = args[:app_engine_release] if args.key?(:app_engine_release) + @method_prop = args[:method_prop] if args.key?(:method_prop) + @cost = args[:cost] if args.key?(:cost) + @instance_id = args[:instance_id] if args.key?(:instance_id) + @mega_cycles = args[:mega_cycles] if args.key?(:mega_cycles) + @first = args[:first] if args.key?(:first) + end + end + + # Result returned from ListMonitoredResourceDescriptors. + class ListMonitoredResourceDescriptorsResponse + include Google::Apis::Core::Hashable + + # A list of resource descriptors. + # Corresponds to the JSON property `resourceDescriptors` + # @return [Array] + attr_accessor :resource_descriptors + + # If there might be more results than those appearing in this response, then + # nextPageToken is included. To get the next set of results, call this method + # again using the value of nextPageToken as pageToken. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_descriptors = args[:resource_descriptors] if args.key?(:resource_descriptors) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A reference to a particular snapshot of the source tree used to build and + # deploy an application. + class SourceReference + include Google::Apis::Core::Hashable + + # Optional. A URI string identifying the repository. Example: "https://github. + # com/GoogleCloudPlatform/kubernetes.git" + # Corresponds to the JSON property `repository` + # @return [String] + attr_accessor :repository + + # The canonical and persistent identifier of the deployed revision. Example (git) + # : "0035781c50ec7aa23385dc841529ce8a4b70db1b" + # Corresponds to the JSON property `revisionId` + # @return [String] + attr_accessor :revision_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @repository = args[:repository] if args.key?(:repository) + @revision_id = args[:revision_id] if args.key?(:revision_id) + end + end end end end diff --git a/generated/google/apis/logging_v2beta1/representations.rb b/generated/google/apis/logging_v2beta1/representations.rb index 95efd87ad..73051c44d 100644 --- a/generated/google/apis/logging_v2beta1/representations.rb +++ b/generated/google/apis/logging_v2beta1/representations.rb @@ -22,54 +22,6 @@ module Google module Apis module LoggingV2beta1 - class ListLogMetricsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LogEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SourceLocation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListLogEntriesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RequestLog - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListMonitoredResourceDescriptorsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SourceReference - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class LogMetric class Representation < Google::Apis::Core::JsonRepresentation; end @@ -112,13 +64,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ListSinksResponse + class HttpRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class HttpRequest + class ListSinksResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -155,128 +107,60 @@ module Google end class ListLogMetricsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :metrics, as: 'metrics', class: Google::Apis::LoggingV2beta1::LogMetric, decorator: Google::Apis::LoggingV2beta1::LogMetric::Representation + class Representation < Google::Apis::Core::JsonRepresentation; end - property :next_page_token, as: 'nextPageToken' - end + include Google::Apis::Core::JsonObjectSupport end class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport end class LogEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :timestamp, as: 'timestamp' - property :log_name, as: 'logName' - property :http_request, as: 'httpRequest', class: Google::Apis::LoggingV2beta1::HttpRequest, decorator: Google::Apis::LoggingV2beta1::HttpRequest::Representation + class Representation < Google::Apis::Core::JsonRepresentation; end - property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation - - hash :json_payload, as: 'jsonPayload' - property :insert_id, as: 'insertId' - property :operation, as: 'operation', class: Google::Apis::LoggingV2beta1::LogEntryOperation, decorator: Google::Apis::LoggingV2beta1::LogEntryOperation::Representation - - property :text_payload, as: 'textPayload' - hash :proto_payload, as: 'protoPayload' - property :trace, as: 'trace' - hash :labels, as: 'labels' - property :severity, as: 'severity' - property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation - - end + include Google::Apis::Core::JsonObjectSupport end class SourceLocation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :line, as: 'line' - property :file, as: 'file' - property :function_name, as: 'functionName' - end + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport end class ListLogEntriesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :project_ids, as: 'projectIds' - property :filter, as: 'filter' - property :page_token, as: 'pageToken' - property :page_size, as: 'pageSize' - property :order_by, as: 'orderBy' - collection :resource_names, as: 'resourceNames' - end + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport end class RequestLog - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :nickname, as: 'nickname' - property :status, as: 'status' - property :resource, as: 'resource' - property :pending_time, as: 'pendingTime' - property :task_name, as: 'taskName' - property :url_map_entry, as: 'urlMapEntry' - property :instance_index, as: 'instanceIndex' - property :host, as: 'host' - property :finished, as: 'finished' - property :http_version, as: 'httpVersion' - property :start_time, as: 'startTime' - property :latency, as: 'latency' - property :ip, as: 'ip' - property :app_id, as: 'appId' - property :app_engine_release, as: 'appEngineRelease' - property :method_prop, as: 'method' - property :cost, as: 'cost' - property :instance_id, as: 'instanceId' - property :mega_cycles, as: 'megaCycles' - property :first, as: 'first' - property :version_id, as: 'versionId' - property :module_id, as: 'moduleId' - property :end_time, as: 'endTime' - property :user_agent, as: 'userAgent' - property :was_loading_request, as: 'wasLoadingRequest' - collection :source_reference, as: 'sourceReference', class: Google::Apis::LoggingV2beta1::SourceReference, decorator: Google::Apis::LoggingV2beta1::SourceReference::Representation + class Representation < Google::Apis::Core::JsonRepresentation; end - property :response_size, as: 'responseSize' - property :trace_id, as: 'traceId' - collection :line, as: 'line', class: Google::Apis::LoggingV2beta1::LogLine, decorator: Google::Apis::LoggingV2beta1::LogLine::Representation - - property :task_queue_name, as: 'taskQueueName' - property :referrer, as: 'referrer' - property :request_id, as: 'requestId' - end + include Google::Apis::Core::JsonObjectSupport end class ListMonitoredResourceDescriptorsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor, decorator: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor::Representation + class Representation < Google::Apis::Core::JsonRepresentation; end - end + include Google::Apis::Core::JsonObjectSupport end class SourceReference - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :repository, as: 'repository' - property :revision_id, as: 'revisionId' - end + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport end class LogMetric # @private class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :description, as: 'description' property :version, as: 'version' property :filter, as: 'filter' + property :name, as: 'name' + property :description, as: 'description' end end @@ -307,26 +191,26 @@ module Google class LogSink # @private class Representation < Google::Apis::Core::JsonRepresentation + property :writer_identity, as: 'writerIdentity' + property :start_time, as: 'startTime' property :output_version_format, as: 'outputVersionFormat' property :name, as: 'name' - property :destination, as: 'destination' property :filter, as: 'filter' + property :destination, as: 'destination' property :end_time, as: 'endTime' - property :start_time, as: 'startTime' - property :writer_identity, as: 'writerIdentity' end end class WriteLogEntriesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation + property :log_name, as: 'logName' collection :entries, as: 'entries', class: Google::Apis::LoggingV2beta1::LogEntry, decorator: Google::Apis::LoggingV2beta1::LogEntry::Representation property :partial_success, as: 'partialSuccess' - hash :labels, as: 'labels' - property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation - end end @@ -338,23 +222,9 @@ module Google end end - class ListSinksResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :sinks, as: 'sinks', class: Google::Apis::LoggingV2beta1::LogSink, decorator: Google::Apis::LoggingV2beta1::LogSink::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - class HttpRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :request_size, as: 'requestSize' - property :response_size, as: 'responseSize' - property :request_url, as: 'requestUrl' - property :remote_ip, as: 'remoteIp' - property :server_ip, as: 'serverIp' property :cache_lookup, as: 'cacheLookup' property :cache_hit, as: 'cacheHit' property :cache_validated_with_origin_server, as: 'cacheValidatedWithOriginServer' @@ -364,36 +234,50 @@ module Google property :user_agent, as: 'userAgent' property :cache_fill_bytes, as: 'cacheFillBytes' property :request_method, as: 'requestMethod' + property :response_size, as: 'responseSize' + property :request_size, as: 'requestSize' + property :request_url, as: 'requestUrl' + property :server_ip, as: 'serverIp' + property :remote_ip, as: 'remoteIp' + end + end + + class ListSinksResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :sinks, as: 'sinks', class: Google::Apis::LoggingV2beta1::LogSink, decorator: Google::Apis::LoggingV2beta1::LogSink::Representation + end end class LabelDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' property :description, as: 'description' property :value_type, as: 'valueType' - property :key, as: 'key' end end class MonitoredResourceDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation - property :type, as: 'type' - collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation - property :name, as: 'name' property :display_name, as: 'displayName' property :description, as: 'description' + property :type, as: 'type' + collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation + end end class LogEntrySourceLocation # @private class Representation < Google::Apis::Core::JsonRepresentation + property :line, as: 'line' property :file, as: 'file' property :function, as: 'function' - property :line, as: 'line' end end @@ -416,6 +300,122 @@ module Google property :time, as: 'time' end end + + class ListLogMetricsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics', class: Google::Apis::LoggingV2beta1::LogMetric, decorator: Google::Apis::LoggingV2beta1::LogMetric::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class LogEntry + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :trace, as: 'trace' + property :severity, as: 'severity' + property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation + + property :timestamp, as: 'timestamp' + property :log_name, as: 'logName' + property :http_request, as: 'httpRequest', class: Google::Apis::LoggingV2beta1::HttpRequest, decorator: Google::Apis::LoggingV2beta1::HttpRequest::Representation + + property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation + + hash :json_payload, as: 'jsonPayload' + property :operation, as: 'operation', class: Google::Apis::LoggingV2beta1::LogEntryOperation, decorator: Google::Apis::LoggingV2beta1::LogEntryOperation::Representation + + property :insert_id, as: 'insertId' + property :text_payload, as: 'textPayload' + hash :proto_payload, as: 'protoPayload' + end + end + + class SourceLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :line, as: 'line' + property :file, as: 'file' + property :function_name, as: 'functionName' + end + end + + class ListLogEntriesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :order_by, as: 'orderBy' + collection :resource_names, as: 'resourceNames' + property :filter, as: 'filter' + collection :project_ids, as: 'projectIds' + property :page_token, as: 'pageToken' + property :page_size, as: 'pageSize' + end + end + + class RequestLog + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version_id, as: 'versionId' + property :module_id, as: 'moduleId' + property :end_time, as: 'endTime' + property :user_agent, as: 'userAgent' + property :was_loading_request, as: 'wasLoadingRequest' + collection :source_reference, as: 'sourceReference', class: Google::Apis::LoggingV2beta1::SourceReference, decorator: Google::Apis::LoggingV2beta1::SourceReference::Representation + + property :response_size, as: 'responseSize' + property :trace_id, as: 'traceId' + collection :line, as: 'line', class: Google::Apis::LoggingV2beta1::LogLine, decorator: Google::Apis::LoggingV2beta1::LogLine::Representation + + property :referrer, as: 'referrer' + property :task_queue_name, as: 'taskQueueName' + property :request_id, as: 'requestId' + property :nickname, as: 'nickname' + property :resource, as: 'resource' + property :pending_time, as: 'pendingTime' + property :status, as: 'status' + property :task_name, as: 'taskName' + property :url_map_entry, as: 'urlMapEntry' + property :instance_index, as: 'instanceIndex' + property :host, as: 'host' + property :finished, as: 'finished' + property :http_version, as: 'httpVersion' + property :start_time, as: 'startTime' + property :latency, as: 'latency' + property :ip, as: 'ip' + property :app_id, as: 'appId' + property :app_engine_release, as: 'appEngineRelease' + property :method_prop, as: 'method' + property :cost, as: 'cost' + property :instance_id, as: 'instanceId' + property :mega_cycles, as: 'megaCycles' + property :first, as: 'first' + end + end + + class ListMonitoredResourceDescriptorsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor, decorator: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class SourceReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :repository, as: 'repository' + property :revision_id, as: 'revisionId' + end + end end end end diff --git a/generated/google/apis/logging_v2beta1/service.rb b/generated/google/apis/logging_v2beta1/service.rb index 325294921..b417dc992 100644 --- a/generated/google/apis/logging_v2beta1/service.rb +++ b/generated/google/apis/logging_v2beta1/service.rb @@ -32,100 +32,20 @@ module Google # # @see https://cloud.google.com/logging/docs/ class LoggingService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - # @return [String] # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + def initialize super('https://logging.googleapis.com/', '') end - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_billing_account_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists the logs in projects or organizations. Only logs that have entries are - # listed. - # @param [String] parent - # Required. The resource name that owns the logs: - # "projects/[PROJECT_ID]" - # "organizations/[ORGANIZATION_ID]" - # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive values are ignored. The presence of nextPageToken in the response - # indicates that more results might be available. - # @param [String] page_token - # Optional. If present, then retrieve the next batch of results from the - # preceding call to this method. pageToken must be the value of nextPageToken - # from the previous response. The values of other method parameters should be - # identical to those in the previous call. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_billing_account_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) - command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation - command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Lists the descriptors for monitored resource types used by Stackdriver Logging. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the @@ -136,11 +56,11 @@ module Google # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -153,14 +73,50 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_monitored_resource_descriptors(page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_monitored_resource_descriptors(page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/monitoredResourceDescriptors', options) command.response_representation = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Deletes all the log entries in a log. The log reappears if it receives new + # entries. + # @param [String] log_name + # Required. The resource name of the log to delete: + # "projects/[PROJECT_ID]/logs/[LOG_ID]" + # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" + # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" + # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% + # 2Factivity". For more information about log names, see LogEntry. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_log(log_name, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+logName}', options) + command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation + command.response_class = Google::Apis::LoggingV2beta1::Empty + command.params['logName'] = log_name unless log_name.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -179,11 +135,11 @@ module Google # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -196,62 +152,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_logs(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_organization_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_organization_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists log entries. Use this method to retrieve log entries from Stackdriver # Logging. For ways to export log entries, see Exporting Logs. # @param [Google::Apis::LoggingV2beta1::ListLogEntriesRequest] list_log_entries_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -264,25 +184,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def list_entry_log_entries(list_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:list', options) command.request_representation = Google::Apis::LoggingV2beta1::ListLogEntriesRequest::Representation command.request_object = list_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::ListLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogEntriesResponse - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end # Writes log entries to Stackdriver Logging. All log entries are written by this # method. # @param [Google::Apis::LoggingV2beta1::WriteLogEntriesRequest] write_log_entries_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -295,14 +215,50 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/entries:write', options) command.request_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesRequest::Representation command.request_object = write_log_entries_request_object command.response_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Deletes all the log entries in a log. The log reappears if it receives new + # entries. + # @param [String] log_name + # Required. The resource name of the log to delete: + # "projects/[PROJECT_ID]/logs/[LOG_ID]" + # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" + # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" + # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% + # 2Factivity". For more information about log names, see LogEntry. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_log(log_name, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+logName}', options) + command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation + command.response_class = Google::Apis::LoggingV2beta1::Empty + command.params['logName'] = log_name unless log_name.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -321,11 +277,11 @@ module Google # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -338,51 +294,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_logs(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes all the log entries in a log. The log reappears if it receives new - # entries. - # @param [String] log_name - # Required. The resource name of the log to delete: - # "projects/[PROJECT_ID]/logs/[LOG_ID]" - # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" - # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% - # 2Factivity". For more information about log names, see LogEntry. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::LoggingV2beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_log(log_name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/{+logName}', options) - command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation - command.response_class = Google::Apis::LoggingV2beta1::Empty - command.params['logName'] = log_name unless log_name.nil? command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -395,11 +315,11 @@ module Google # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" # It is an error if the sink does not exist. Example: "projects/my-project-id/ # sinks/my-sink-id". It is an error if the sink does not exist. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -412,13 +332,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) + def delete_project_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+sinkName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['sinkName'] = sink_name unless sink_name.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -435,11 +355,11 @@ module Google # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -452,15 +372,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_sinks(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_sinks(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/sinks', options) command.response_representation = Google::Apis::LoggingV2beta1::ListSinksResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListSinksResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -470,11 +390,11 @@ module Google # "projects/[PROJECT_ID]/sinks/[SINK_ID]" # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" # Example: "projects/my-project-id/sinks/my-sink-id". - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -487,13 +407,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) + def get_project_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+sinkName}', options) command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_name.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -519,11 +439,11 @@ module Google # If the old value was false and the new value is true, then writer_identity is # changed to a unique service account. # It is an error if the old value was true and the new value is false. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -536,7 +456,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block) + def update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+sinkName}', options) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object @@ -544,8 +464,8 @@ module Google command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['sinkName'] = sink_name unless sink_name.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -570,11 +490,11 @@ module Google # resource such as an organization, then the value of writer_identity will be a # unique service account used only for exports from the new sink. For more # information, see writer_identity in LogSink. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -587,7 +507,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block) + def create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/sinks', options) command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation command.request_object = log_sink_object @@ -595,8 +515,8 @@ module Google command.response_class = Google::Apis::LoggingV2beta1::LogSink command.params['parent'] = parent unless parent.nil? command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -604,11 +524,11 @@ module Google # @param [String] metric_name # The resource name of the metric to delete: # "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -621,13 +541,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) + def delete_project_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta1/{+metricName}', options) command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation command.response_class = Google::Apis::LoggingV2beta1::Empty command.params['metricName'] = metric_name unless metric_name.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -644,11 +564,11 @@ module Google # Optional. The maximum number of results to return from this request. Non- # positive values are ignored. The presence of nextPageToken in the response # indicates that more results might be available. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -661,15 +581,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_metrics(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_metrics(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+parent}/metrics', options) command.response_representation = Google::Apis::LoggingV2beta1::ListLogMetricsResponse::Representation command.response_class = Google::Apis::LoggingV2beta1::ListLogMetricsResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -677,11 +597,11 @@ module Google # @param [String] metric_name # The resource name of the desired metric: # "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -694,13 +614,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block) + def get_project_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/{+metricName}', options) command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_name.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -712,11 +632,11 @@ module Google # the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a # new metric is created. # @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -729,15 +649,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:put, 'v2beta1/{+metricName}', options) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['metricName'] = metric_name unless metric_name.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -747,11 +667,11 @@ module Google # "projects/[PROJECT_ID]" # The new metric must be provided in the request. # @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -764,23 +684,103 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def create_project_metric(parent, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', options) command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.request_object = log_metric_object command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation command.response_class = Google::Apis::LoggingV2beta1::LogMetric command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Deletes all the log entries in a log. The log reappears if it receives new + # entries. + # @param [String] log_name + # Required. The resource name of the log to delete: + # "projects/[PROJECT_ID]/logs/[LOG_ID]" + # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" + # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" + # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% + # 2Factivity". For more information about log names, see LogEntry. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+logName}', options) + command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation + command.response_class = Google::Apis::LoggingV2beta1::Empty + command.params['logName'] = log_name unless log_name.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Lists the logs in projects or organizations. Only logs that have entries are + # listed. + # @param [String] parent + # Required. The resource name that owns the logs: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # @param [String] page_token + # Optional. If present, then retrieve the next batch of results from the + # preceding call to this method. pageToken must be the value of nextPageToken + # from the previous response. The values of other method parameters should be + # identical to those in the previous call. + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. The presence of nextPageToken in the response + # indicates that more results might be available. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2beta1::ListLogsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_billing_account_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options) + command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation + command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end protected def apply_command_defaults(command) - command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['key'] = key unless key.nil? end end end diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index a031af07a..481fab98e 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20170120' + REVISION = '20170123' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/plus_domains_v1.rb b/generated/google/apis/plus_domains_v1.rb index 223dbe751..44f663082 100644 --- a/generated/google/apis/plus_domains_v1.rb +++ b/generated/google/apis/plus_domains_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/+/domains/ module PlusDomainsV1 VERSION = 'V1' - REVISION = '20170118' + REVISION = '20170123' # View your circles and the people and pages in them AUTH_PLUS_CIRCLES_READ = 'https://www.googleapis.com/auth/plus.circles.read' diff --git a/generated/google/apis/plus_v1.rb b/generated/google/apis/plus_v1.rb index 2fee49681..376d68035 100644 --- a/generated/google/apis/plus_v1.rb +++ b/generated/google/apis/plus_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/+/api/ module PlusV1 VERSION = 'V1' - REVISION = '20170118' + REVISION = '20170123' # Know the list of people in your circles, your age range, and language AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login' diff --git a/generated/google/apis/sheets_v4.rb b/generated/google/apis/sheets_v4.rb index 72ed02684..220a5b792 100644 --- a/generated/google/apis/sheets_v4.rb +++ b/generated/google/apis/sheets_v4.rb @@ -27,15 +27,15 @@ module Google VERSION = 'V4' REVISION = '20170117' - # View and manage the files in your Google Drive - AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' - # View the files in your Google Drive AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly' # View your Google Spreadsheets AUTH_SPREADSHEETS_READONLY = 'https://www.googleapis.com/auth/spreadsheets.readonly' + # View and manage the files in your Google Drive + AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' + # View and manage your spreadsheets in Google Drive AUTH_SPREADSHEETS = 'https://www.googleapis.com/auth/spreadsheets' end diff --git a/generated/google/apis/sheets_v4/classes.rb b/generated/google/apis/sheets_v4/classes.rb index 1d0533798..5c2a0c09e 100644 --- a/generated/google/apis/sheets_v4/classes.rb +++ b/generated/google/apis/sheets_v4/classes.rb @@ -22,88 +22,617 @@ module Google module Apis module SheetsV4 - # The response when updating a range of values in a spreadsheet. - class UpdateValuesResponse + # The result of adding a named range. + class AddNamedRangeResponse include Google::Apis::Core::Hashable - # Data within a range of the spreadsheet. - # Corresponds to the JSON property `updatedData` - # @return [Google::Apis::SheetsV4::ValueRange] - attr_accessor :updated_data + # A named range. + # Corresponds to the JSON property `namedRange` + # @return [Google::Apis::SheetsV4::NamedRange] + attr_accessor :named_range - # The number of rows where at least one cell in the row was updated. - # Corresponds to the JSON property `updatedRows` - # @return [Fixnum] - attr_accessor :updated_rows + def initialize(**args) + update!(**args) + end - # The number of columns where at least one cell in the column was updated. - # Corresponds to the JSON property `updatedColumns` + # Update properties of this object + def update!(**args) + @named_range = args[:named_range] if args.key?(:named_range) + end + end + + # Updates an existing protected range with the specified + # protectedRangeId. + class UpdateProtectedRangeRequest + include Google::Apis::Core::Hashable + + # A protected range. + # Corresponds to the JSON property `protectedRange` + # @return [Google::Apis::SheetsV4::ProtectedRange] + attr_accessor :protected_range + + # The fields that should be updated. At least one field must be specified. + # The root `protectedRange` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @protected_range = args[:protected_range] if args.key?(:protected_range) + @fields = args[:fields] if args.key?(:fields) + end + end + + # The amount of padding around the cell, in pixels. + # When updating padding, every field must be specified. + class Padding + include Google::Apis::Core::Hashable + + # The right padding of the cell. + # Corresponds to the JSON property `right` # @return [Fixnum] - attr_accessor :updated_columns + attr_accessor :right + + # The left padding of the cell. + # Corresponds to the JSON property `left` + # @return [Fixnum] + attr_accessor :left + + # The top padding of the cell. + # Corresponds to the JSON property `top` + # @return [Fixnum] + attr_accessor :top + + # The bottom padding of the cell. + # Corresponds to the JSON property `bottom` + # @return [Fixnum] + attr_accessor :bottom + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @right = args[:right] if args.key?(:right) + @left = args[:left] if args.key?(:left) + @top = args[:top] if args.key?(:top) + @bottom = args[:bottom] if args.key?(:bottom) + end + end + + # Merges all cells in the range. + class MergeCellsRequest + include Google::Apis::Core::Hashable + + # How the cells should be merged. + # Corresponds to the JSON property `mergeType` + # @return [String] + attr_accessor :merge_type + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @merge_type = args[:merge_type] if args.key?(:merge_type) + @range = args[:range] if args.key?(:range) + end + end + + # The result of adding a sheet. + class AddSheetResponse + include Google::Apis::Core::Hashable + + # Properties of a sheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SheetProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + end + end + + # Metadata about a value in a pivot grouping. + class PivotGroupValueMetadata + include Google::Apis::Core::Hashable + + # The kinds of value that a cell in a spreadsheet can have. + # Corresponds to the JSON property `value` + # @return [Google::Apis::SheetsV4::ExtendedValue] + attr_accessor :value + + # True if the data corresponding to the value is collapsed. + # Corresponds to the JSON property `collapsed` + # @return [Boolean] + attr_accessor :collapsed + alias_method :collapsed?, :collapsed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + @collapsed = args[:collapsed] if args.key?(:collapsed) + end + end + + # The result of updating an embedded object's position. + class UpdateEmbeddedObjectPositionResponse + include Google::Apis::Core::Hashable + + # The position of an embedded object such as a chart. + # Corresponds to the JSON property `position` + # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] + attr_accessor :position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @position = args[:position] if args.key?(:position) + end + end + + # The response when clearing a range of values in a spreadsheet. + class ClearValuesResponse + include Google::Apis::Core::Hashable # The spreadsheet the updates were applied to. # Corresponds to the JSON property `spreadsheetId` # @return [String] attr_accessor :spreadsheet_id - # The range (in A1 notation) that updates were applied to. - # Corresponds to the JSON property `updatedRange` + # The range (in A1 notation) that was cleared. + # (If the request was for an unbounded range or a ranger larger + # than the bounds of the sheet, this will be the actual range + # that was cleared, bounded to the sheet's limits.) + # Corresponds to the JSON property `clearedRange` # @return [String] - attr_accessor :updated_range + attr_accessor :cleared_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @cleared_range = args[:cleared_range] if args.key?(:cleared_range) + end + end + + # Updates a conditional format rule at the given index, + # or moves a conditional format rule to another index. + class UpdateConditionalFormatRuleRequest + include Google::Apis::Core::Hashable + + # The sheet of the rule to move. Required if new_index is set, + # unused otherwise. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # A rule describing a conditional format. + # Corresponds to the JSON property `rule` + # @return [Google::Apis::SheetsV4::ConditionalFormatRule] + attr_accessor :rule + + # The zero-based index of the rule that should be replaced or moved. + # Corresponds to the JSON property `index` + # @return [Fixnum] + attr_accessor :index + + # The zero-based new index the rule should end up at. + # Corresponds to the JSON property `newIndex` + # @return [Fixnum] + attr_accessor :new_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @rule = args[:rule] if args.key?(:rule) + @index = args[:index] if args.key?(:index) + @new_index = args[:new_index] if args.key?(:new_index) + end + end + + # The format of a run of text in a cell. + # Absent values indicate that the field isn't specified. + class TextFormat + include Google::Apis::Core::Hashable + + # True if the text is bold. + # Corresponds to the JSON property `bold` + # @return [Boolean] + attr_accessor :bold + alias_method :bold?, :bold + + # True if the text is italicized. + # Corresponds to the JSON property `italic` + # @return [Boolean] + attr_accessor :italic + alias_method :italic?, :italic + + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + # Corresponds to the JSON property `foregroundColor` + # @return [Google::Apis::SheetsV4::Color] + attr_accessor :foreground_color + + # The font family. + # Corresponds to the JSON property `fontFamily` + # @return [String] + attr_accessor :font_family + + # True if the text has a strikethrough. + # Corresponds to the JSON property `strikethrough` + # @return [Boolean] + attr_accessor :strikethrough + alias_method :strikethrough?, :strikethrough + + # The size of the font. + # Corresponds to the JSON property `fontSize` + # @return [Fixnum] + attr_accessor :font_size + + # True if the text is underlined. + # Corresponds to the JSON property `underline` + # @return [Boolean] + attr_accessor :underline + alias_method :underline?, :underline + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bold = args[:bold] if args.key?(:bold) + @italic = args[:italic] if args.key?(:italic) + @foreground_color = args[:foreground_color] if args.key?(:foreground_color) + @font_family = args[:font_family] if args.key?(:font_family) + @strikethrough = args[:strikethrough] if args.key?(:strikethrough) + @font_size = args[:font_size] if args.key?(:font_size) + @underline = args[:underline] if args.key?(:underline) + end + end + + # Updates a chart's specifications. + # (This does not move or resize a chart. To move or resize a chart, use + # UpdateEmbeddedObjectPositionRequest.) + class UpdateChartSpecRequest + include Google::Apis::Core::Hashable + + # The ID of the chart to update. + # Corresponds to the JSON property `chartId` + # @return [Fixnum] + attr_accessor :chart_id + + # The specifications of a chart. + # Corresponds to the JSON property `spec` + # @return [Google::Apis::SheetsV4::ChartSpec] + attr_accessor :spec + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart_id = args[:chart_id] if args.key?(:chart_id) + @spec = args[:spec] if args.key?(:spec) + end + end + + # A coordinate in a sheet. + # All indexes are zero-based. + class GridCoordinate + include Google::Apis::Core::Hashable + + # The sheet this coordinate is on. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The row index of the coordinate. + # Corresponds to the JSON property `rowIndex` + # @return [Fixnum] + attr_accessor :row_index + + # The column index of the coordinate. + # Corresponds to the JSON property `columnIndex` + # @return [Fixnum] + attr_accessor :column_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @row_index = args[:row_index] if args.key?(:row_index) + @column_index = args[:column_index] if args.key?(:column_index) + end + end + + # Deletes a particular filter view. + class DeleteFilterViewRequest + include Google::Apis::Core::Hashable + + # The ID of the filter to delete. + # Corresponds to the JSON property `filterId` + # @return [Fixnum] + attr_accessor :filter_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter_id = args[:filter_id] if args.key?(:filter_id) + end + end + + # The response when updating a range of values in a spreadsheet. + class BatchUpdateValuesResponse + include Google::Apis::Core::Hashable + + # The total number of sheets where at least one cell in the sheet was + # updated. + # Corresponds to the JSON property `totalUpdatedSheets` + # @return [Fixnum] + attr_accessor :total_updated_sheets + + # The total number of columns where at least one cell in the column was + # updated. + # Corresponds to the JSON property `totalUpdatedColumns` + # @return [Fixnum] + attr_accessor :total_updated_columns + + # One UpdateValuesResponse per requested range, in the same order as + # the requests appeared. + # Corresponds to the JSON property `responses` + # @return [Array] + attr_accessor :responses + + # The total number of cells updated. + # Corresponds to the JSON property `totalUpdatedCells` + # @return [Fixnum] + attr_accessor :total_updated_cells + + # The spreadsheet the updates were applied to. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + # The total number of rows where at least one cell in the row was updated. + # Corresponds to the JSON property `totalUpdatedRows` + # @return [Fixnum] + attr_accessor :total_updated_rows + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @total_updated_sheets = args[:total_updated_sheets] if args.key?(:total_updated_sheets) + @total_updated_columns = args[:total_updated_columns] if args.key?(:total_updated_columns) + @responses = args[:responses] if args.key?(:responses) + @total_updated_cells = args[:total_updated_cells] if args.key?(:total_updated_cells) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @total_updated_rows = args[:total_updated_rows] if args.key?(:total_updated_rows) + end + end + + # Updates properties of the named range with the specified + # namedRangeId. + class UpdateNamedRangeRequest + include Google::Apis::Core::Hashable + + # The fields that should be updated. At least one field must be specified. + # The root `namedRange` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # A named range. + # Corresponds to the JSON property `namedRange` + # @return [Google::Apis::SheetsV4::NamedRange] + attr_accessor :named_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @named_range = args[:named_range] if args.key?(:named_range) + end + end + + # The response when updating a range of values in a spreadsheet. + class UpdateValuesResponse + include Google::Apis::Core::Hashable + + # The number of columns where at least one cell in the column was updated. + # Corresponds to the JSON property `updatedColumns` + # @return [Fixnum] + attr_accessor :updated_columns # The number of cells updated. # Corresponds to the JSON property `updatedCells` # @return [Fixnum] attr_accessor :updated_cells - def initialize(**args) - update!(**args) - end + # Data within a range of the spreadsheet. + # Corresponds to the JSON property `updatedData` + # @return [Google::Apis::SheetsV4::ValueRange] + attr_accessor :updated_data - # Update properties of this object - def update!(**args) - @updated_data = args[:updated_data] if args.key?(:updated_data) - @updated_rows = args[:updated_rows] if args.key?(:updated_rows) - @updated_columns = args[:updated_columns] if args.key?(:updated_columns) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - @updated_range = args[:updated_range] if args.key?(:updated_range) - @updated_cells = args[:updated_cells] if args.key?(:updated_cells) - end - end + # The range (in A1 notation) that updates were applied to. + # Corresponds to the JSON property `updatedRange` + # @return [String] + attr_accessor :updated_range - # The definition of how a value in a pivot table should be calculated. - class PivotValue - include Google::Apis::Core::Hashable + # The spreadsheet the updates were applied to. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id - # The column offset of the source range that this value reads from. - # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` - # means this value refers to column `C`, whereas the offset `1` would - # refer to column `D`. - # Corresponds to the JSON property `sourceColumnOffset` + # The number of rows where at least one cell in the row was updated. + # Corresponds to the JSON property `updatedRows` # @return [Fixnum] - attr_accessor :source_column_offset - - # A name to use for the value. This is only used if formula was set. - # Otherwise, the column name is used. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # A custom formula to calculate the value. The formula must start - # with an `=` character. - # Corresponds to the JSON property `formula` - # @return [String] - attr_accessor :formula - - # A function to summarize the value. - # If formula is set, the only supported values are - # SUM and - # CUSTOM. - # If sourceColumnOffset is set, then `CUSTOM` - # is not supported. - # Corresponds to the JSON property `summarizeFunction` - # @return [String] - attr_accessor :summarize_function + attr_accessor :updated_rows def initialize(**args) update!(**args) @@ -111,24 +640,275 @@ module Google # Update properties of this object def update!(**args) - @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset) - @name = args[:name] if args.key?(:name) - @formula = args[:formula] if args.key?(:formula) - @summarize_function = args[:summarize_function] if args.key?(:summarize_function) + @updated_columns = args[:updated_columns] if args.key?(:updated_columns) + @updated_cells = args[:updated_cells] if args.key?(:updated_cells) + @updated_data = args[:updated_data] if args.key?(:updated_data) + @updated_range = args[:updated_range] if args.key?(:updated_range) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @updated_rows = args[:updated_rows] if args.key?(:updated_rows) end end - # An error in a cell. - class ErrorValue + # Properties of a spreadsheet. + class SpreadsheetProperties include Google::Apis::Core::Hashable - # A message with more information about the error - # (in the spreadsheet's locale). - # Corresponds to the JSON property `message` + # The time zone of the spreadsheet, in CLDR format such as + # `America/New_York`. If the time zone isn't recognized, this may + # be a custom time zone such as `GMT-07:00`. + # Corresponds to the JSON property `timeZone` # @return [String] - attr_accessor :message + attr_accessor :time_zone - # The type of error. + # The amount of time to wait before volatile functions are recalculated. + # Corresponds to the JSON property `autoRecalc` + # @return [String] + attr_accessor :auto_recalc + + # The locale of the spreadsheet in one of the following formats: + # * an ISO 639-1 language code such as `en` + # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists + # * a combination of the ISO language code and country code, such as `en_US` + # Note: when updating this field, not all locales/languages are supported. + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # The title of the spreadsheet. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The format of a cell. + # Corresponds to the JSON property `defaultFormat` + # @return [Google::Apis::SheetsV4::CellFormat] + attr_accessor :default_format + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time_zone = args[:time_zone] if args.key?(:time_zone) + @auto_recalc = args[:auto_recalc] if args.key?(:auto_recalc) + @locale = args[:locale] if args.key?(:locale) + @title = args[:title] if args.key?(:title) + @default_format = args[:default_format] if args.key?(:default_format) + end + end + + # Data about a specific cell. + class CellData + include Google::Apis::Core::Hashable + + # A hyperlink this cell points to, if any. + # This field is read-only. (To set it, use a `=HYPERLINK` formula.) + # Corresponds to the JSON property `hyperlink` + # @return [String] + attr_accessor :hyperlink + + # The format of a cell. + # Corresponds to the JSON property `effectiveFormat` + # @return [Google::Apis::SheetsV4::CellFormat] + attr_accessor :effective_format + + # Any note on the cell. + # Corresponds to the JSON property `note` + # @return [String] + attr_accessor :note + + # The formatted value of the cell. + # This is the value as it's shown to the user. + # This field is read-only. + # Corresponds to the JSON property `formattedValue` + # @return [String] + attr_accessor :formatted_value + + # The kinds of value that a cell in a spreadsheet can have. + # Corresponds to the JSON property `userEnteredValue` + # @return [Google::Apis::SheetsV4::ExtendedValue] + attr_accessor :user_entered_value + + # A data validation rule. + # Corresponds to the JSON property `dataValidation` + # @return [Google::Apis::SheetsV4::DataValidationRule] + attr_accessor :data_validation + + # The format of a cell. + # Corresponds to the JSON property `userEnteredFormat` + # @return [Google::Apis::SheetsV4::CellFormat] + attr_accessor :user_entered_format + + # A pivot table. + # Corresponds to the JSON property `pivotTable` + # @return [Google::Apis::SheetsV4::PivotTable] + attr_accessor :pivot_table + + # Runs of rich text applied to subsections of the cell. Runs are only valid + # on user entered strings, not formulas, bools, or numbers. + # Runs start at specific indexes in the text and continue until the next + # run. Properties of a run will continue unless explicitly changed + # in a subsequent run (and properties of the first run will continue + # the properties of the cell unless explicitly changed). + # When writing, the new runs will overwrite any prior runs. When writing a + # new user_entered_value, previous runs will be erased. + # Corresponds to the JSON property `textFormatRuns` + # @return [Array] + attr_accessor :text_format_runs + + # The kinds of value that a cell in a spreadsheet can have. + # Corresponds to the JSON property `effectiveValue` + # @return [Google::Apis::SheetsV4::ExtendedValue] + attr_accessor :effective_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hyperlink = args[:hyperlink] if args.key?(:hyperlink) + @effective_format = args[:effective_format] if args.key?(:effective_format) + @note = args[:note] if args.key?(:note) + @formatted_value = args[:formatted_value] if args.key?(:formatted_value) + @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value) + @data_validation = args[:data_validation] if args.key?(:data_validation) + @user_entered_format = args[:user_entered_format] if args.key?(:user_entered_format) + @pivot_table = args[:pivot_table] if args.key?(:pivot_table) + @text_format_runs = args[:text_format_runs] if args.key?(:text_format_runs) + @effective_value = args[:effective_value] if args.key?(:effective_value) + end + end + + # Unmerges cells in the given range. + class UnmergeCellsRequest + include Google::Apis::Core::Hashable + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @range = args[:range] if args.key?(:range) + end + end + + # Splits a column of text into multiple columns, + # based on a delimiter in each cell. + class TextToColumnsRequest + include Google::Apis::Core::Hashable + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `source` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :source + + # The delimiter to use. Used only if delimiterType is + # CUSTOM. + # Corresponds to the JSON property `delimiter` + # @return [String] + attr_accessor :delimiter + + # The delimiter type to use. + # Corresponds to the JSON property `delimiterType` + # @return [String] + attr_accessor :delimiter_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source = args[:source] if args.key?(:source) + @delimiter = args[:delimiter] if args.key?(:delimiter) + @delimiter_type = args[:delimiter_type] if args.key?(:delimiter_type) + end + end + + # The result of adding a new protected range. + class AddProtectedRangeResponse + include Google::Apis::Core::Hashable + + # A protected range. + # Corresponds to the JSON property `protectedRange` + # @return [Google::Apis::SheetsV4::ProtectedRange] + attr_accessor :protected_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @protected_range = args[:protected_range] if args.key?(:protected_range) + end + end + + # A condition that can evaluate to true or false. + # BooleanConditions are used by conditional formatting, + # data validation, and the criteria in filters. + class BooleanCondition + include Google::Apis::Core::Hashable + + # The values of the condition. The number of supported values depends + # on the condition type. Some support zero values, + # others one or two values, + # and ConditionType.ONE_OF_LIST supports an arbitrary number of values. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + # The type of condition. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -139,19 +919,19 @@ module Google # Update properties of this object def update!(**args) - @message = args[:message] if args.key?(:message) + @values = args[:values] if args.key?(:values) @type = args[:type] if args.key?(:type) end end - # The request to copy a sheet across spreadsheets. - class CopySheetToAnotherSpreadsheetRequest + # Deletes the protected range with the given ID. + class DeleteProtectedRangeRequest include Google::Apis::Core::Hashable - # The ID of the spreadsheet to copy the sheet to. - # Corresponds to the JSON property `destinationSpreadsheetId` - # @return [String] - attr_accessor :destination_spreadsheet_id + # The ID of the protected range to delete. + # Corresponds to the JSON property `protectedRangeId` + # @return [Fixnum] + attr_accessor :protected_range_id def initialize(**args) update!(**args) @@ -159,7 +939,1509 @@ module Google # Update properties of this object def update!(**args) - @destination_spreadsheet_id = args[:destination_spreadsheet_id] if args.key?(:destination_spreadsheet_id) + @protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id) + end + end + + # The domain of a chart. + # For example, if charting stock prices over time, this would be the date. + class BasicChartDomain + include Google::Apis::Core::Hashable + + # The data included in a domain or series. + # Corresponds to the JSON property `domain` + # @return [Google::Apis::SheetsV4::ChartData] + attr_accessor :domain + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @domain = args[:domain] if args.key?(:domain) + end + end + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + class DimensionRange + include Google::Apis::Core::Hashable + + # The sheet this span is on. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The end (exclusive) of the span, or not set if unbounded. + # Corresponds to the JSON property `endIndex` + # @return [Fixnum] + attr_accessor :end_index + + # The start (inclusive) of the span, or not set if unbounded. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The dimension of the span. + # Corresponds to the JSON property `dimension` + # @return [String] + attr_accessor :dimension + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @end_index = args[:end_index] if args.key?(:end_index) + @start_index = args[:start_index] if args.key?(:start_index) + @dimension = args[:dimension] if args.key?(:dimension) + end + end + + # A single response from an update. + class Response + include Google::Apis::Core::Hashable + + # The result of updating an embedded object's position. + # Corresponds to the JSON property `updateEmbeddedObjectPosition` + # @return [Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse] + attr_accessor :update_embedded_object_position + + # The result of adding a filter view. + # Corresponds to the JSON property `addFilterView` + # @return [Google::Apis::SheetsV4::AddFilterViewResponse] + attr_accessor :add_filter_view + + # The result of adding a sheet. + # Corresponds to the JSON property `addSheet` + # @return [Google::Apis::SheetsV4::AddSheetResponse] + attr_accessor :add_sheet + + # The result of the find/replace. + # Corresponds to the JSON property `findReplace` + # @return [Google::Apis::SheetsV4::FindReplaceResponse] + attr_accessor :find_replace + + # The result of adding a new protected range. + # Corresponds to the JSON property `addProtectedRange` + # @return [Google::Apis::SheetsV4::AddProtectedRangeResponse] + attr_accessor :add_protected_range + + # The result of updating a conditional format rule. + # Corresponds to the JSON property `updateConditionalFormatRule` + # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse] + attr_accessor :update_conditional_format_rule + + # The result of adding a chart to a spreadsheet. + # Corresponds to the JSON property `addChart` + # @return [Google::Apis::SheetsV4::AddChartResponse] + attr_accessor :add_chart + + # The result of deleting a conditional format rule. + # Corresponds to the JSON property `deleteConditionalFormatRule` + # @return [Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse] + attr_accessor :delete_conditional_format_rule + + # The result of adding a banded range. + # Corresponds to the JSON property `addBanding` + # @return [Google::Apis::SheetsV4::AddBandingResponse] + attr_accessor :add_banding + + # The result of duplicating a sheet. + # Corresponds to the JSON property `duplicateSheet` + # @return [Google::Apis::SheetsV4::DuplicateSheetResponse] + attr_accessor :duplicate_sheet + + # The result of a filter view being duplicated. + # Corresponds to the JSON property `duplicateFilterView` + # @return [Google::Apis::SheetsV4::DuplicateFilterViewResponse] + attr_accessor :duplicate_filter_view + + # The result of adding a named range. + # Corresponds to the JSON property `addNamedRange` + # @return [Google::Apis::SheetsV4::AddNamedRangeResponse] + attr_accessor :add_named_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @update_embedded_object_position = args[:update_embedded_object_position] if args.key?(:update_embedded_object_position) + @add_filter_view = args[:add_filter_view] if args.key?(:add_filter_view) + @add_sheet = args[:add_sheet] if args.key?(:add_sheet) + @find_replace = args[:find_replace] if args.key?(:find_replace) + @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range) + @update_conditional_format_rule = args[:update_conditional_format_rule] if args.key?(:update_conditional_format_rule) + @add_chart = args[:add_chart] if args.key?(:add_chart) + @delete_conditional_format_rule = args[:delete_conditional_format_rule] if args.key?(:delete_conditional_format_rule) + @add_banding = args[:add_banding] if args.key?(:add_banding) + @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet) + @duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view) + @add_named_range = args[:add_named_range] if args.key?(:add_named_range) + end + end + + # Adds a new conditional format rule at the given index. + # All subsequent rules' indexes are incremented. + class AddConditionalFormatRuleRequest + include Google::Apis::Core::Hashable + + # A rule describing a conditional format. + # Corresponds to the JSON property `rule` + # @return [Google::Apis::SheetsV4::ConditionalFormatRule] + attr_accessor :rule + + # The zero-based index where the rule should be inserted. + # Corresponds to the JSON property `index` + # @return [Fixnum] + attr_accessor :index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rule = args[:rule] if args.key?(:rule) + @index = args[:index] if args.key?(:index) + end + end + + # A filter view. + class FilterView + include Google::Apis::Core::Hashable + + # The name of the filter view. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The named range this filter view is backed by, if any. + # When writing, only one of range or named_range_id + # may be set. + # Corresponds to the JSON property `namedRangeId` + # @return [String] + attr_accessor :named_range_id + + # The sort order per column. Later specifications are used when values + # are equal in the earlier specifications. + # Corresponds to the JSON property `sortSpecs` + # @return [Array] + attr_accessor :sort_specs + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # The criteria for showing/hiding values per column. + # The map's key is the column index, and the value is the criteria for + # that column. + # Corresponds to the JSON property `criteria` + # @return [Hash] + attr_accessor :criteria + + # The ID of the filter view. + # Corresponds to the JSON property `filterViewId` + # @return [Fixnum] + attr_accessor :filter_view_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @title = args[:title] if args.key?(:title) + @named_range_id = args[:named_range_id] if args.key?(:named_range_id) + @sort_specs = args[:sort_specs] if args.key?(:sort_specs) + @range = args[:range] if args.key?(:range) + @criteria = args[:criteria] if args.key?(:criteria) + @filter_view_id = args[:filter_view_id] if args.key?(:filter_view_id) + end + end + + # Sorts data in rows based on a sort order per column. + class SortRangeRequest + include Google::Apis::Core::Hashable + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # The sort order per column. Later specifications are used when values + # are equal in the earlier specifications. + # Corresponds to the JSON property `sortSpecs` + # @return [Array] + attr_accessor :sort_specs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @range = args[:range] if args.key?(:range) + @sort_specs = args[:sort_specs] if args.key?(:sort_specs) + end + end + + # The result of adding a banded range. + class AddBandingResponse + include Google::Apis::Core::Hashable + + # A banded (alternating colors) range in a sheet. + # Corresponds to the JSON property `bandedRange` + # @return [Google::Apis::SheetsV4::BandedRange] + attr_accessor :banded_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @banded_range = args[:banded_range] if args.key?(:banded_range) + end + end + + # A run of a text format. The format of this run continues until the start + # index of the next run. + # When updating, all fields must be set. + class TextFormatRun + include Google::Apis::Core::Hashable + + # The character index where this run starts. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The format of a run of text in a cell. + # Absent values indicate that the field isn't specified. + # Corresponds to the JSON property `format` + # @return [Google::Apis::SheetsV4::TextFormat] + attr_accessor :format + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @start_index = args[:start_index] if args.key?(:start_index) + @format = args[:format] if args.key?(:format) + end + end + + # Updates properties of the filter view. + class UpdateFilterViewRequest + include Google::Apis::Core::Hashable + + # A filter view. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::SheetsV4::FilterView] + attr_accessor :filter + + # The fields that should be updated. At least one field must be specified. + # The root `filter` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + @fields = args[:fields] if args.key?(:fields) + end + end + + # The result of updating a conditional format rule. + class UpdateConditionalFormatRuleResponse + include Google::Apis::Core::Hashable + + # The old index of the rule. Not set if a rule was replaced + # (because it is the same as new_index). + # Corresponds to the JSON property `oldIndex` + # @return [Fixnum] + attr_accessor :old_index + + # A rule describing a conditional format. + # Corresponds to the JSON property `newRule` + # @return [Google::Apis::SheetsV4::ConditionalFormatRule] + attr_accessor :new_rule + + # A rule describing a conditional format. + # Corresponds to the JSON property `oldRule` + # @return [Google::Apis::SheetsV4::ConditionalFormatRule] + attr_accessor :old_rule + + # The index of the new rule. + # Corresponds to the JSON property `newIndex` + # @return [Fixnum] + attr_accessor :new_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @old_index = args[:old_index] if args.key?(:old_index) + @new_rule = args[:new_rule] if args.key?(:new_rule) + @old_rule = args[:old_rule] if args.key?(:old_rule) + @new_index = args[:new_index] if args.key?(:new_index) + end + end + + # Criteria for showing/hiding rows in a filter or filter view. + class FilterCriteria + include Google::Apis::Core::Hashable + + # A condition that can evaluate to true or false. + # BooleanConditions are used by conditional formatting, + # data validation, and the criteria in filters. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::SheetsV4::BooleanCondition] + attr_accessor :condition + + # Values that should be hidden. + # Corresponds to the JSON property `hiddenValues` + # @return [Array] + attr_accessor :hidden_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @hidden_values = args[:hidden_values] if args.key?(:hidden_values) + end + end + + # Deletes the dimensions from the sheet. + class DeleteDimensionRequest + include Google::Apis::Core::Hashable + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::DimensionRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @range = args[:range] if args.key?(:range) + end + end + + # A pivot table. + class PivotTable + include Google::Apis::Core::Hashable + + # Whether values should be listed horizontally (as columns) + # or vertically (as rows). + # Corresponds to the JSON property `valueLayout` + # @return [String] + attr_accessor :value_layout + + # Each column grouping in the pivot table. + # Corresponds to the JSON property `columns` + # @return [Array] + attr_accessor :columns + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `source` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :source + + # Each row grouping in the pivot table. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # A list of values to include in the pivot table. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + # An optional mapping of filters per source column offset. + # The filters will be applied before aggregating data into the pivot table. + # The map's key is the column offset of the source range that you want to + # filter, and the value is the criteria for that column. + # For example, if the source was `C10:E15`, a key of `0` will have the filter + # for column `C`, whereas the key `1` is for column `D`. + # Corresponds to the JSON property `criteria` + # @return [Hash] + attr_accessor :criteria + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value_layout = args[:value_layout] if args.key?(:value_layout) + @columns = args[:columns] if args.key?(:columns) + @source = args[:source] if args.key?(:source) + @rows = args[:rows] if args.key?(:rows) + @values = args[:values] if args.key?(:values) + @criteria = args[:criteria] if args.key?(:criteria) + end + end + + # A data validation rule. + class DataValidationRule + include Google::Apis::Core::Hashable + + # A condition that can evaluate to true or false. + # BooleanConditions are used by conditional formatting, + # data validation, and the criteria in filters. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::SheetsV4::BooleanCondition] + attr_accessor :condition + + # A message to show the user when adding data to the cell. + # Corresponds to the JSON property `inputMessage` + # @return [String] + attr_accessor :input_message + + # True if the UI should be customized based on the kind of condition. + # If true, "List" conditions will show a dropdown. + # Corresponds to the JSON property `showCustomUi` + # @return [Boolean] + attr_accessor :show_custom_ui + alias_method :show_custom_ui?, :show_custom_ui + + # True if invalid data should be rejected. + # Corresponds to the JSON property `strict` + # @return [Boolean] + attr_accessor :strict + alias_method :strict?, :strict + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @input_message = args[:input_message] if args.key?(:input_message) + @show_custom_ui = args[:show_custom_ui] if args.key?(:show_custom_ui) + @strict = args[:strict] if args.key?(:strict) + end + end + + # Updates properties of a spreadsheet. + class UpdateSpreadsheetPropertiesRequest + include Google::Apis::Core::Hashable + + # The fields that should be updated. At least one field must be specified. + # The root 'properties' is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # Properties of a spreadsheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SpreadsheetProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @properties = args[:properties] if args.key?(:properties) + end + end + + # Source ranges for a chart. + class ChartSourceRange + include Google::Apis::Core::Hashable + + # The ranges of data for a series or domain. + # Exactly one dimension must have a length of 1, + # and all sources in the list must have the same dimension + # with length 1. + # The domain (if it exists) & all series must have the same number + # of source ranges. If using more than one source range, then the source + # range at a given offset must be contiguous across the domain and series. + # For example, these are valid configurations: + # domain sources: A1:A5 + # series1 sources: B1:B5 + # series2 sources: D6:D10 + # domain sources: A1:A5, C10:C12 + # series1 sources: B1:B5, D10:D12 + # series2 sources: C1:C5, E10:E12 + # Corresponds to the JSON property `sources` + # @return [Array] + attr_accessor :sources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sources = args[:sources] if args.key?(:sources) + end + end + + # The request for updating more than one range of values in a spreadsheet. + class BatchUpdateValuesRequest + include Google::Apis::Core::Hashable + + # How the input data should be interpreted. + # Corresponds to the JSON property `valueInputOption` + # @return [String] + attr_accessor :value_input_option + + # The new values to apply to the spreadsheet. + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # Determines how values in the response should be rendered. + # The default render option is ValueRenderOption.FORMATTED_VALUE. + # Corresponds to the JSON property `responseValueRenderOption` + # @return [String] + attr_accessor :response_value_render_option + + # Determines how dates, times, and durations in the response should be + # rendered. This is ignored if response_value_render_option is + # FORMATTED_VALUE. + # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # Corresponds to the JSON property `responseDateTimeRenderOption` + # @return [String] + attr_accessor :response_date_time_render_option + + # Determines if the update response should include the values + # of the cells that were updated. By default, responses + # do not include the updated values. The `updatedData` field within + # each of the BatchUpdateValuesResponse.responses will contain + # the updated values. If the range to write was larger than than the range + # actually written, the response will include all values in the requested + # range (excluding trailing empty rows and columns). + # Corresponds to the JSON property `includeValuesInResponse` + # @return [Boolean] + attr_accessor :include_values_in_response + alias_method :include_values_in_response?, :include_values_in_response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value_input_option = args[:value_input_option] if args.key?(:value_input_option) + @data = args[:data] if args.key?(:data) + @response_value_render_option = args[:response_value_render_option] if args.key?(:response_value_render_option) + @response_date_time_render_option = args[:response_date_time_render_option] if args.key?(:response_date_time_render_option) + @include_values_in_response = args[:include_values_in_response] if args.key?(:include_values_in_response) + end + end + + # Clears the basic filter, if any exists on the sheet. + class ClearBasicFilterRequest + include Google::Apis::Core::Hashable + + # The sheet ID on which the basic filter should be cleared. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + end + end + + # The response when updating a range of values in a spreadsheet. + class BatchClearValuesResponse + include Google::Apis::Core::Hashable + + # The spreadsheet the updates were applied to. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + # The ranges that were cleared, in A1 notation. + # (If the requests were for an unbounded range or a ranger larger + # than the bounds of the sheet, this will be the actual ranges + # that were cleared, bounded to the sheet's limits.) + # Corresponds to the JSON property `clearedRanges` + # @return [Array] + attr_accessor :cleared_ranges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @cleared_ranges = args[:cleared_ranges] if args.key?(:cleared_ranges) + end + end + + # A rule describing a conditional format. + class ConditionalFormatRule + include Google::Apis::Core::Hashable + + # A rule that applies a gradient color scale format, based on + # the interpolation points listed. The format of a cell will vary + # based on its contents as compared to the values of the interpolation + # points. + # Corresponds to the JSON property `gradientRule` + # @return [Google::Apis::SheetsV4::GradientRule] + attr_accessor :gradient_rule + + # A rule that may or may not match, depending on the condition. + # Corresponds to the JSON property `booleanRule` + # @return [Google::Apis::SheetsV4::BooleanRule] + attr_accessor :boolean_rule + + # The ranges that will be formatted if the condition is true. + # All the ranges must be on the same grid. + # Corresponds to the JSON property `ranges` + # @return [Array] + attr_accessor :ranges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gradient_rule = args[:gradient_rule] if args.key?(:gradient_rule) + @boolean_rule = args[:boolean_rule] if args.key?(:boolean_rule) + @ranges = args[:ranges] if args.key?(:ranges) + end + end + + # Updates the borders of a range. + # If a field is not set in the request, that means the border remains as-is. + # For example, with two subsequent UpdateBordersRequest: + # 1. range: A1:A5 `` top: RED, bottom: WHITE `` + # 2. range: A1:A5 `` left: BLUE `` + # That would result in A1:A5 having a borders of + # `` top: RED, bottom: WHITE, left: BLUE ``. + # If you want to clear a border, explicitly set the style to + # NONE. + class UpdateBordersRequest + include Google::Apis::Core::Hashable + + # A border along a cell. + # Corresponds to the JSON property `right` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :right + + # A border along a cell. + # Corresponds to the JSON property `innerVertical` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :inner_vertical + + # A border along a cell. + # Corresponds to the JSON property `top` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :top + + # A border along a cell. + # Corresponds to the JSON property `innerHorizontal` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :inner_horizontal + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # A border along a cell. + # Corresponds to the JSON property `bottom` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :bottom + + # A border along a cell. + # Corresponds to the JSON property `left` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :left + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @right = args[:right] if args.key?(:right) + @inner_vertical = args[:inner_vertical] if args.key?(:inner_vertical) + @top = args[:top] if args.key?(:top) + @inner_horizontal = args[:inner_horizontal] if args.key?(:inner_horizontal) + @range = args[:range] if args.key?(:range) + @bottom = args[:bottom] if args.key?(:bottom) + @left = args[:left] if args.key?(:left) + end + end + + # Criteria for showing/hiding rows in a pivot table. + class PivotFilterCriteria + include Google::Apis::Core::Hashable + + # Values that should be included. Values not listed here are excluded. + # Corresponds to the JSON property `visibleValues` + # @return [Array] + attr_accessor :visible_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @visible_values = args[:visible_values] if args.key?(:visible_values) + end + end + + # The borders of the cell. + class Borders + include Google::Apis::Core::Hashable + + # A border along a cell. + # Corresponds to the JSON property `left` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :left + + # A border along a cell. + # Corresponds to the JSON property `right` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :right + + # A border along a cell. + # Corresponds to the JSON property `top` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :top + + # A border along a cell. + # Corresponds to the JSON property `bottom` + # @return [Google::Apis::SheetsV4::Border] + attr_accessor :bottom + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @left = args[:left] if args.key?(:left) + @right = args[:right] if args.key?(:right) + @top = args[:top] if args.key?(:top) + @bottom = args[:bottom] if args.key?(:bottom) + end + end + + # A chart embedded in a sheet. + class EmbeddedChart + include Google::Apis::Core::Hashable + + # The ID of the chart. + # Corresponds to the JSON property `chartId` + # @return [Fixnum] + attr_accessor :chart_id + + # The position of an embedded object such as a chart. + # Corresponds to the JSON property `position` + # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] + attr_accessor :position + + # The specifications of a chart. + # Corresponds to the JSON property `spec` + # @return [Google::Apis::SheetsV4::ChartSpec] + attr_accessor :spec + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart_id = args[:chart_id] if args.key?(:chart_id) + @position = args[:position] if args.key?(:position) + @spec = args[:spec] if args.key?(:spec) + end + end + + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + class Color + include Google::Apis::Core::Hashable + + # The amount of green in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `green` + # @return [Float] + attr_accessor :green + + # The amount of blue in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `blue` + # @return [Float] + attr_accessor :blue + + # The amount of red in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `red` + # @return [Float] + attr_accessor :red + + # The fraction of this color that should be applied to the pixel. That is, + # the final pixel color is defined by the equation: + # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) + # This means that a value of 1.0 corresponds to a solid color, whereas + # a value of 0.0 corresponds to a completely transparent color. This + # uses a wrapper message rather than a simple float scalar so that it is + # possible to distinguish between a default value and the value being unset. + # If omitted, this color object is to be rendered as a solid color + # (as if the alpha value had been explicitly given with a value of 1.0). + # Corresponds to the JSON property `alpha` + # @return [Float] + attr_accessor :alpha + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @green = args[:green] if args.key?(:green) + @blue = args[:blue] if args.key?(:blue) + @red = args[:red] if args.key?(:red) + @alpha = args[:alpha] if args.key?(:alpha) + end + end + + # Adds a new sheet. + # When a sheet is added at a given index, + # all subsequent sheets' indexes are incremented. + # To add an object sheet, use AddChartRequest instead and specify + # EmbeddedObjectPosition.sheetId or + # EmbeddedObjectPosition.newSheet. + class AddSheetRequest + include Google::Apis::Core::Hashable + + # Properties of a sheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SheetProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + end + end + + # Adds a new protected range. + class AddProtectedRangeRequest + include Google::Apis::Core::Hashable + + # A protected range. + # Corresponds to the JSON property `protectedRange` + # @return [Google::Apis::SheetsV4::ProtectedRange] + attr_accessor :protected_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @protected_range = args[:protected_range] if args.key?(:protected_range) + end + end + + # Data within a range of the spreadsheet. + class ValueRange + include Google::Apis::Core::Hashable + + # The data that was read or to be written. This is an array of arrays, + # the outer array representing all the data and each inner array + # representing a major dimension. Each item in the inner array + # corresponds with one cell. + # For output, empty trailing rows and columns will not be included. + # For input, supported value types are: bool, string, and double. + # Null values will be skipped. + # To set a cell to an empty value, set the string value to an empty string. + # Corresponds to the JSON property `values` + # @return [Array>] + attr_accessor :values + + # The range the values cover, in A1 notation. + # For output, this range indicates the entire requested range, + # even though the values will exclude trailing rows and columns. + # When appending values, this field represents the range to search for a + # table, after which values will be appended. + # Corresponds to the JSON property `range` + # @return [String] + attr_accessor :range + + # The major dimension of the values. + # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, + # then requesting `range=A1:B2,majorDimension=ROWS` will return + # `[[1,2],[3,4]]`, + # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return + # `[[1,3],[2,4]]`. + # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` + # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` + # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. + # When writing, if this field is not set, it defaults to ROWS. + # Corresponds to the JSON property `majorDimension` + # @return [String] + attr_accessor :major_dimension + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + @range = args[:range] if args.key?(:range) + @major_dimension = args[:major_dimension] if args.key?(:major_dimension) + end + end + + # The result of the find/replace. + class FindReplaceResponse + include Google::Apis::Core::Hashable + + # The number of non-formula cells changed. + # Corresponds to the JSON property `valuesChanged` + # @return [Fixnum] + attr_accessor :values_changed + + # The number of rows changed. + # Corresponds to the JSON property `rowsChanged` + # @return [Fixnum] + attr_accessor :rows_changed + + # The number of occurrences (possibly multiple within a cell) changed. + # For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would + # be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. + # Corresponds to the JSON property `occurrencesChanged` + # @return [Fixnum] + attr_accessor :occurrences_changed + + # The number of formula cells changed. + # Corresponds to the JSON property `formulasChanged` + # @return [Fixnum] + attr_accessor :formulas_changed + + # The number of sheets changed. + # Corresponds to the JSON property `sheetsChanged` + # @return [Fixnum] + attr_accessor :sheets_changed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values_changed = args[:values_changed] if args.key?(:values_changed) + @rows_changed = args[:rows_changed] if args.key?(:rows_changed) + @occurrences_changed = args[:occurrences_changed] if args.key?(:occurrences_changed) + @formulas_changed = args[:formulas_changed] if args.key?(:formulas_changed) + @sheets_changed = args[:sheets_changed] if args.key?(:sheets_changed) + end + end + + # The response when updating a range of values in a spreadsheet. + class AppendValuesResponse + include Google::Apis::Core::Hashable + + # The spreadsheet the updates were applied to. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + # The range (in A1 notation) of the table that values are being appended to + # (before the values were appended). + # Empty if no table was found. + # Corresponds to the JSON property `tableRange` + # @return [String] + attr_accessor :table_range + + # The response when updating a range of values in a spreadsheet. + # Corresponds to the JSON property `updates` + # @return [Google::Apis::SheetsV4::UpdateValuesResponse] + attr_accessor :updates + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @table_range = args[:table_range] if args.key?(:table_range) + @updates = args[:updates] if args.key?(:updates) + end + end + + # The format of a cell. + class CellFormat + include Google::Apis::Core::Hashable + + # The horizontal alignment of the value in the cell. + # Corresponds to the JSON property `horizontalAlignment` + # @return [String] + attr_accessor :horizontal_alignment + + # How a hyperlink, if it exists, should be displayed in the cell. + # Corresponds to the JSON property `hyperlinkDisplayType` + # @return [String] + attr_accessor :hyperlink_display_type + + # The borders of the cell. + # Corresponds to the JSON property `borders` + # @return [Google::Apis::SheetsV4::Borders] + attr_accessor :borders + + # The direction of the text in the cell. + # Corresponds to the JSON property `textDirection` + # @return [String] + attr_accessor :text_direction + + # The format of a run of text in a cell. + # Absent values indicate that the field isn't specified. + # Corresponds to the JSON property `textFormat` + # @return [Google::Apis::SheetsV4::TextFormat] + attr_accessor :text_format + + # The amount of padding around the cell, in pixels. + # When updating padding, every field must be specified. + # Corresponds to the JSON property `padding` + # @return [Google::Apis::SheetsV4::Padding] + attr_accessor :padding + + # The number format of a cell. + # Corresponds to the JSON property `numberFormat` + # @return [Google::Apis::SheetsV4::NumberFormat] + attr_accessor :number_format + + # The wrap strategy for the value in the cell. + # Corresponds to the JSON property `wrapStrategy` + # @return [String] + attr_accessor :wrap_strategy + + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + # Corresponds to the JSON property `backgroundColor` + # @return [Google::Apis::SheetsV4::Color] + attr_accessor :background_color + + # The vertical alignment of the value in the cell. + # Corresponds to the JSON property `verticalAlignment` + # @return [String] + attr_accessor :vertical_alignment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) + @hyperlink_display_type = args[:hyperlink_display_type] if args.key?(:hyperlink_display_type) + @borders = args[:borders] if args.key?(:borders) + @text_direction = args[:text_direction] if args.key?(:text_direction) + @text_format = args[:text_format] if args.key?(:text_format) + @padding = args[:padding] if args.key?(:padding) + @number_format = args[:number_format] if args.key?(:number_format) + @wrap_strategy = args[:wrap_strategy] if args.key?(:wrap_strategy) + @background_color = args[:background_color] if args.key?(:background_color) + @vertical_alignment = args[:vertical_alignment] if args.key?(:vertical_alignment) + end + end + + # Moves one or more rows or columns. + class MoveDimensionRequest + include Google::Apis::Core::Hashable + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + # Corresponds to the JSON property `source` + # @return [Google::Apis::SheetsV4::DimensionRange] + attr_accessor :source + + # The zero-based start index of where to move the source data to, + # based on the coordinates *before* the source data is removed + # from the grid. Existing data will be shifted down or right + # (depending on the dimension) to make room for the moved dimensions. + # The source dimensions are removed from the grid, so the + # the data may end up in a different index than specified. + # For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move + # `"1"` and `"2"` to between `"3"` and `"4"`, the source would be + # `ROWS [1..3)`,and the destination index would be `"4"` + # (the zero-based index of row 5). + # The end result would be `A1..A5` of `0, 3, 1, 2, 4`. + # Corresponds to the JSON property `destinationIndex` + # @return [Fixnum] + attr_accessor :destination_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source = args[:source] if args.key?(:source) + @destination_index = args[:destination_index] if args.key?(:destination_index) + end + end + + # An axis of the chart. + # A chart may not have more than one axis per + # axis position. + class BasicChartAxis + include Google::Apis::Core::Hashable + + # The position of this axis. + # Corresponds to the JSON property `position` + # @return [String] + attr_accessor :position + + # The title of this axis. If set, this overrides any title inferred + # from headers of the data. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The format of a run of text in a cell. + # Absent values indicate that the field isn't specified. + # Corresponds to the JSON property `format` + # @return [Google::Apis::SheetsV4::TextFormat] + attr_accessor :format + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @position = args[:position] if args.key?(:position) + @title = args[:title] if args.key?(:title) + @format = args[:format] if args.key?(:format) end end @@ -196,17 +2478,44 @@ module Google end end + # Properties about a dimension. + class DimensionProperties + include Google::Apis::Core::Hashable + + # True if this dimension is explicitly hidden. + # Corresponds to the JSON property `hiddenByUser` + # @return [Boolean] + attr_accessor :hidden_by_user + alias_method :hidden_by_user?, :hidden_by_user + + # The height (if a row) or width (if a column) of the dimension in pixels. + # Corresponds to the JSON property `pixelSize` + # @return [Fixnum] + attr_accessor :pixel_size + + # True if this dimension is being filtered. + # This field is read-only. + # Corresponds to the JSON property `hiddenByFilter` + # @return [Boolean] + attr_accessor :hidden_by_filter + alias_method :hidden_by_filter?, :hidden_by_filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hidden_by_user = args[:hidden_by_user] if args.key?(:hidden_by_user) + @pixel_size = args[:pixel_size] if args.key?(:pixel_size) + @hidden_by_filter = args[:hidden_by_filter] if args.key?(:hidden_by_filter) + end + end + # The position of an embedded object such as a chart. class EmbeddedObjectPosition include Google::Apis::Core::Hashable - # If true, the embedded object will be put on a new sheet whose ID - # is chosen for you. Used only when writing. - # Corresponds to the JSON property `newSheet` - # @return [Boolean] - attr_accessor :new_sheet - alias_method :new_sheet?, :new_sheet - # The sheet this is on. Set only if the embedded object # is on its own sheet. Must be non-negative. # Corresponds to the JSON property `sheetId` @@ -218,160 +2527,22 @@ module Google # @return [Google::Apis::SheetsV4::OverlayPosition] attr_accessor :overlay_position + # If true, the embedded object will be put on a new sheet whose ID + # is chosen for you. Used only when writing. + # Corresponds to the JSON property `newSheet` + # @return [Boolean] + attr_accessor :new_sheet + alias_method :new_sheet?, :new_sheet + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @new_sheet = args[:new_sheet] if args.key?(:new_sheet) @sheet_id = args[:sheet_id] if args.key?(:sheet_id) @overlay_position = args[:overlay_position] if args.key?(:overlay_position) - end - end - - # Deletes the protected range with the given ID. - class DeleteProtectedRangeRequest - include Google::Apis::Core::Hashable - - # The ID of the protected range to delete. - # Corresponds to the JSON property `protectedRangeId` - # @return [Fixnum] - attr_accessor :protected_range_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id) - end - end - - # Fills in more data based on existing data. - class AutoFillRequest - include Google::Apis::Core::Hashable - - # True if we should generate data with the "alternate" series. - # This differs based on the type and amount of source data. - # Corresponds to the JSON property `useAlternateSeries` - # @return [Boolean] - attr_accessor :use_alternate_series - alias_method :use_alternate_series?, :use_alternate_series - - # A combination of a source range and how to extend that source. - # Corresponds to the JSON property `sourceAndDestination` - # @return [Google::Apis::SheetsV4::SourceAndDestination] - attr_accessor :source_and_destination - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @use_alternate_series = args[:use_alternate_series] if args.key?(:use_alternate_series) - @source_and_destination = args[:source_and_destination] if args.key?(:source_and_destination) - @range = args[:range] if args.key?(:range) - end - end - - # A rule that applies a gradient color scale format, based on - # the interpolation points listed. The format of a cell will vary - # based on its contents as compared to the values of the interpolation - # points. - class GradientRule - include Google::Apis::Core::Hashable - - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. - # Corresponds to the JSON property `minpoint` - # @return [Google::Apis::SheetsV4::InterpolationPoint] - attr_accessor :minpoint - - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. - # Corresponds to the JSON property `maxpoint` - # @return [Google::Apis::SheetsV4::InterpolationPoint] - attr_accessor :maxpoint - - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. - # Corresponds to the JSON property `midpoint` - # @return [Google::Apis::SheetsV4::InterpolationPoint] - attr_accessor :midpoint - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @minpoint = args[:minpoint] if args.key?(:minpoint) - @maxpoint = args[:maxpoint] if args.key?(:maxpoint) - @midpoint = args[:midpoint] if args.key?(:midpoint) - end - end - - # Sets the basic filter associated with a sheet. - class SetBasicFilterRequest - include Google::Apis::Core::Hashable - - # The default filter associated with a sheet. - # Corresponds to the JSON property `filter` - # @return [Google::Apis::SheetsV4::BasicFilter] - attr_accessor :filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - end - end - - # The request for clearing a range of values in a spreadsheet. - class ClearValuesRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) + @new_sheet = args[:new_sheet] if args.key?(:new_sheet) end end @@ -381,6 +2552,13 @@ module Google class InterpolationPoint include Google::Apis::Core::Hashable + # The value this interpolation point uses. May be a formula. + # Unused if type is MIN or + # MAX. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various # languages over compactness; for example, the fields of this representation @@ -489,55 +2667,32 @@ module Google # @return [String] attr_accessor :type - # The value this interpolation point uses. May be a formula. - # Unused if type is MIN or - # MAX. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @value = args[:value] if args.key?(:value) @color = args[:color] if args.key?(:color) @type = args[:type] if args.key?(:type) - @value = args[:value] if args.key?(:value) end end - # The result of the find/replace. - class FindReplaceResponse + # An error in a cell. + class ErrorValue include Google::Apis::Core::Hashable - # The number of non-formula cells changed. - # Corresponds to the JSON property `valuesChanged` - # @return [Fixnum] - attr_accessor :values_changed + # The type of error. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type - # The number of occurrences (possibly multiple within a cell) changed. - # For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would - # be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. - # Corresponds to the JSON property `occurrencesChanged` - # @return [Fixnum] - attr_accessor :occurrences_changed - - # The number of rows changed. - # Corresponds to the JSON property `rowsChanged` - # @return [Fixnum] - attr_accessor :rows_changed - - # The number of sheets changed. - # Corresponds to the JSON property `sheetsChanged` - # @return [Fixnum] - attr_accessor :sheets_changed - - # The number of formula cells changed. - # Corresponds to the JSON property `formulasChanged` - # @return [Fixnum] - attr_accessor :formulas_changed + # A message with more information about the error + # (in the spreadsheet's locale). + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message def initialize(**args) update!(**args) @@ -545,49 +2700,8 @@ module Google # Update properties of this object def update!(**args) - @values_changed = args[:values_changed] if args.key?(:values_changed) - @occurrences_changed = args[:occurrences_changed] if args.key?(:occurrences_changed) - @rows_changed = args[:rows_changed] if args.key?(:rows_changed) - @sheets_changed = args[:sheets_changed] if args.key?(:sheets_changed) - @formulas_changed = args[:formulas_changed] if args.key?(:formulas_changed) - end - end - - # Deletes the embedded object with the given ID. - class DeleteEmbeddedObjectRequest - include Google::Apis::Core::Hashable - - # The ID of the embedded object to delete. - # Corresponds to the JSON property `objectId` - # @return [Fixnum] - attr_accessor :object_id_prop - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) - end - end - - # Deletes the requested sheet. - class DeleteSheetRequest - include Google::Apis::Core::Hashable - - # The ID of the sheet to delete. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @type = args[:type] if args.key?(:type) + @message = args[:message] if args.key?(:message) end end @@ -610,4175 +2724,6 @@ module Google end end - # The result of updating a conditional format rule. - class UpdateConditionalFormatRuleResponse - include Google::Apis::Core::Hashable - - # The old index of the rule. Not set if a rule was replaced - # (because it is the same as new_index). - # Corresponds to the JSON property `oldIndex` - # @return [Fixnum] - attr_accessor :old_index - - # A rule describing a conditional format. - # Corresponds to the JSON property `newRule` - # @return [Google::Apis::SheetsV4::ConditionalFormatRule] - attr_accessor :new_rule - - # A rule describing a conditional format. - # Corresponds to the JSON property `oldRule` - # @return [Google::Apis::SheetsV4::ConditionalFormatRule] - attr_accessor :old_rule - - # The index of the new rule. - # Corresponds to the JSON property `newIndex` - # @return [Fixnum] - attr_accessor :new_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @old_index = args[:old_index] if args.key?(:old_index) - @new_rule = args[:new_rule] if args.key?(:new_rule) - @old_rule = args[:old_rule] if args.key?(:old_rule) - @new_index = args[:new_index] if args.key?(:new_index) - end - end - - # The value of the condition. - class ConditionValue - include Google::Apis::Core::Hashable - - # A relative date (based on the current date). - # Valid only if the type is - # DATE_BEFORE, - # DATE_AFTER, - # DATE_ON_OR_BEFORE or - # DATE_ON_OR_AFTER. - # Relative dates are not supported in data validation. - # They are supported only in conditional formatting and - # conditional filters. - # Corresponds to the JSON property `relativeDate` - # @return [String] - attr_accessor :relative_date - - # A value the condition is based on. - # The value will be parsed as if the user typed into a cell. - # Formulas are supported (and must begin with an `=`). - # Corresponds to the JSON property `userEnteredValue` - # @return [String] - attr_accessor :user_entered_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @relative_date = args[:relative_date] if args.key?(:relative_date) - @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value) - end - end - - # Duplicates the contents of a sheet. - class DuplicateSheetRequest - include Google::Apis::Core::Hashable - - # The name of the new sheet. If empty, a new name is chosen for you. - # Corresponds to the JSON property `newSheetName` - # @return [String] - attr_accessor :new_sheet_name - - # The sheet to duplicate. - # Corresponds to the JSON property `sourceSheetId` - # @return [Fixnum] - attr_accessor :source_sheet_id - - # If set, the ID of the new sheet. If not set, an ID is chosen. - # If set, the ID must not conflict with any existing sheet ID. - # If set, it must be non-negative. - # Corresponds to the JSON property `newSheetId` - # @return [Fixnum] - attr_accessor :new_sheet_id - - # The zero-based index where the new sheet should be inserted. - # The index of all sheets after this are incremented. - # Corresponds to the JSON property `insertSheetIndex` - # @return [Fixnum] - attr_accessor :insert_sheet_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_sheet_name = args[:new_sheet_name] if args.key?(:new_sheet_name) - @source_sheet_id = args[:source_sheet_id] if args.key?(:source_sheet_id) - @new_sheet_id = args[:new_sheet_id] if args.key?(:new_sheet_id) - @insert_sheet_index = args[:insert_sheet_index] if args.key?(:insert_sheet_index) - end - end - - # The kinds of value that a cell in a spreadsheet can have. - class ExtendedValue - include Google::Apis::Core::Hashable - - # An error in a cell. - # Corresponds to the JSON property `errorValue` - # @return [Google::Apis::SheetsV4::ErrorValue] - attr_accessor :error_value - - # Represents a string value. - # Leading single quotes are not included. For example, if the user typed - # `'123` into the UI, this would be represented as a `stringValue` of - # `"123"`. - # Corresponds to the JSON property `stringValue` - # @return [String] - attr_accessor :string_value - - # Represents a boolean value. - # Corresponds to the JSON property `boolValue` - # @return [Boolean] - attr_accessor :bool_value - alias_method :bool_value?, :bool_value - - # Represents a formula. - # Corresponds to the JSON property `formulaValue` - # @return [String] - attr_accessor :formula_value - - # Represents a double value. - # Note: Dates, Times and DateTimes are represented as doubles in - # "serial number" format. - # Corresponds to the JSON property `numberValue` - # @return [Float] - attr_accessor :number_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @error_value = args[:error_value] if args.key?(:error_value) - @string_value = args[:string_value] if args.key?(:string_value) - @bool_value = args[:bool_value] if args.key?(:bool_value) - @formula_value = args[:formula_value] if args.key?(:formula_value) - @number_value = args[:number_value] if args.key?(:number_value) - end - end - - # Adds a chart to a sheet in the spreadsheet. - class AddChartRequest - include Google::Apis::Core::Hashable - - # A chart embedded in a sheet. - # Corresponds to the JSON property `chart` - # @return [Google::Apis::SheetsV4::EmbeddedChart] - attr_accessor :chart - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @chart = args[:chart] if args.key?(:chart) - end - end - - # Resource that represents a spreadsheet. - class Spreadsheet - include Google::Apis::Core::Hashable - - # Properties of a spreadsheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SpreadsheetProperties] - attr_accessor :properties - - # The ID of the spreadsheet. - # This field is read-only. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - # The sheets that are part of a spreadsheet. - # Corresponds to the JSON property `sheets` - # @return [Array] - attr_accessor :sheets - - # The named ranges defined in a spreadsheet. - # Corresponds to the JSON property `namedRanges` - # @return [Array] - attr_accessor :named_ranges - - # The url of the spreadsheet. - # This field is read-only. - # Corresponds to the JSON property `spreadsheetUrl` - # @return [String] - attr_accessor :spreadsheet_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @properties = args[:properties] if args.key?(:properties) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - @sheets = args[:sheets] if args.key?(:sheets) - @named_ranges = args[:named_ranges] if args.key?(:named_ranges) - @spreadsheet_url = args[:spreadsheet_url] if args.key?(:spreadsheet_url) - end - end - - # The response when updating a range of values in a spreadsheet. - class BatchClearValuesResponse - include Google::Apis::Core::Hashable - - # The ranges that were cleared, in A1 notation. - # (If the requests were for an unbounded range or a ranger larger - # than the bounds of the sheet, this will be the actual ranges - # that were cleared, bounded to the sheet's limits.) - # Corresponds to the JSON property `clearedRanges` - # @return [Array] - attr_accessor :cleared_ranges - - # The spreadsheet the updates were applied to. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @cleared_ranges = args[:cleared_ranges] if args.key?(:cleared_ranges) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - end - end - - # A banded (alternating colors) range in a sheet. - class BandedRange - include Google::Apis::Core::Hashable - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # The id of the banded range. - # Corresponds to the JSON property `bandedRangeId` - # @return [Fixnum] - attr_accessor :banded_range_id - - # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row - # color if the row header is not set. - # Corresponds to the JSON property `rowProperties` - # @return [Google::Apis::SheetsV4::BandingProperties] - attr_accessor :row_properties - - # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row - # color if the row header is not set. - # Corresponds to the JSON property `columnProperties` - # @return [Google::Apis::SheetsV4::BandingProperties] - attr_accessor :column_properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @range = args[:range] if args.key?(:range) - @banded_range_id = args[:banded_range_id] if args.key?(:banded_range_id) - @row_properties = args[:row_properties] if args.key?(:row_properties) - @column_properties = args[:column_properties] if args.key?(:column_properties) - end - end - - # Updates an existing protected range with the specified - # protectedRangeId. - class UpdateProtectedRangeRequest - include Google::Apis::Core::Hashable - - # A protected range. - # Corresponds to the JSON property `protectedRange` - # @return [Google::Apis::SheetsV4::ProtectedRange] - attr_accessor :protected_range - - # The fields that should be updated. At least one field must be specified. - # The root `protectedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @protected_range = args[:protected_range] if args.key?(:protected_range) - @fields = args[:fields] if args.key?(:fields) - end - end - - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. - class TextFormat - include Google::Apis::Core::Hashable - - # The font family. - # Corresponds to the JSON property `fontFamily` - # @return [String] - attr_accessor :font_family - - # True if the text has a strikethrough. - # Corresponds to the JSON property `strikethrough` - # @return [Boolean] - attr_accessor :strikethrough - alias_method :strikethrough?, :strikethrough - - # True if the text is italicized. - # Corresponds to the JSON property `italic` - # @return [Boolean] - attr_accessor :italic - alias_method :italic?, :italic - - # The size of the font. - # Corresponds to the JSON property `fontSize` - # @return [Fixnum] - attr_accessor :font_size - - # True if the text is underlined. - # Corresponds to the JSON property `underline` - # @return [Boolean] - attr_accessor :underline - alias_method :underline?, :underline - - # True if the text is bold. - # Corresponds to the JSON property `bold` - # @return [Boolean] - attr_accessor :bold - alias_method :bold?, :bold - - # Represents a color in the RGBA color space. This representation is designed - # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. Here are some examples: - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... - # Corresponds to the JSON property `foregroundColor` - # @return [Google::Apis::SheetsV4::Color] - attr_accessor :foreground_color - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @font_family = args[:font_family] if args.key?(:font_family) - @strikethrough = args[:strikethrough] if args.key?(:strikethrough) - @italic = args[:italic] if args.key?(:italic) - @font_size = args[:font_size] if args.key?(:font_size) - @underline = args[:underline] if args.key?(:underline) - @bold = args[:bold] if args.key?(:bold) - @foreground_color = args[:foreground_color] if args.key?(:foreground_color) - end - end - - # The result of adding a sheet. - class AddSheetResponse - include Google::Apis::Core::Hashable - - # Properties of a sheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SheetProperties] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @properties = args[:properties] if args.key?(:properties) - end - end - - # The result of adding a filter view. - class AddFilterViewResponse - include Google::Apis::Core::Hashable - - # A filter view. - # Corresponds to the JSON property `filter` - # @return [Google::Apis::SheetsV4::FilterView] - attr_accessor :filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - end - end - - # Properties of a spreadsheet. - class SpreadsheetProperties - include Google::Apis::Core::Hashable - - # The locale of the spreadsheet in one of the following formats: - # * an ISO 639-1 language code such as `en` - # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists - # * a combination of the ISO language code and country code, such as `en_US` - # Note: when updating this field, not all locales/languages are supported. - # Corresponds to the JSON property `locale` - # @return [String] - attr_accessor :locale - - # The amount of time to wait before volatile functions are recalculated. - # Corresponds to the JSON property `autoRecalc` - # @return [String] - attr_accessor :auto_recalc - - # The format of a cell. - # Corresponds to the JSON property `defaultFormat` - # @return [Google::Apis::SheetsV4::CellFormat] - attr_accessor :default_format - - # The title of the spreadsheet. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # The time zone of the spreadsheet, in CLDR format such as - # `America/New_York`. If the time zone isn't recognized, this may - # be a custom time zone such as `GMT-07:00`. - # Corresponds to the JSON property `timeZone` - # @return [String] - attr_accessor :time_zone - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @locale = args[:locale] if args.key?(:locale) - @auto_recalc = args[:auto_recalc] if args.key?(:auto_recalc) - @default_format = args[:default_format] if args.key?(:default_format) - @title = args[:title] if args.key?(:title) - @time_zone = args[:time_zone] if args.key?(:time_zone) - end - end - - # The location an object is overlaid on top of a grid. - class OverlayPosition - include Google::Apis::Core::Hashable - - # The width of the object, in pixels. Defaults to 600. - # Corresponds to the JSON property `widthPixels` - # @return [Fixnum] - attr_accessor :width_pixels - - # The horizontal offset, in pixels, that the object is offset - # from the anchor cell. - # Corresponds to the JSON property `offsetXPixels` - # @return [Fixnum] - attr_accessor :offset_x_pixels - - # A coordinate in a sheet. - # All indexes are zero-based. - # Corresponds to the JSON property `anchorCell` - # @return [Google::Apis::SheetsV4::GridCoordinate] - attr_accessor :anchor_cell - - # The vertical offset, in pixels, that the object is offset - # from the anchor cell. - # Corresponds to the JSON property `offsetYPixels` - # @return [Fixnum] - attr_accessor :offset_y_pixels - - # The height of the object, in pixels. Defaults to 371. - # Corresponds to the JSON property `heightPixels` - # @return [Fixnum] - attr_accessor :height_pixels - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @width_pixels = args[:width_pixels] if args.key?(:width_pixels) - @offset_x_pixels = args[:offset_x_pixels] if args.key?(:offset_x_pixels) - @anchor_cell = args[:anchor_cell] if args.key?(:anchor_cell) - @offset_y_pixels = args[:offset_y_pixels] if args.key?(:offset_y_pixels) - @height_pixels = args[:height_pixels] if args.key?(:height_pixels) - end - end - - # Updates all cells in the range to the values in the given Cell object. - # Only the fields listed in the fields field are updated; others are - # unchanged. - # If writing a cell with a formula, the formula's ranges will automatically - # increment for each field in the range. - # For example, if writing a cell with formula `=A1` into range B2:C4, - # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, - # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. - # To keep the formula's ranges static, use the `$` indicator. - # For example, use the formula `=$A$1` to prevent both the row and the - # column from incrementing. - class RepeatCellRequest - include Google::Apis::Core::Hashable - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # The fields that should be updated. At least one field must be specified. - # The root `cell` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # Data about a specific cell. - # Corresponds to the JSON property `cell` - # @return [Google::Apis::SheetsV4::CellData] - attr_accessor :cell - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @range = args[:range] if args.key?(:range) - @fields = args[:fields] if args.key?(:fields) - @cell = args[:cell] if args.key?(:cell) - end - end - - # The result of adding a chart to a spreadsheet. - class AddChartResponse - include Google::Apis::Core::Hashable - - # A chart embedded in a sheet. - # Corresponds to the JSON property `chart` - # @return [Google::Apis::SheetsV4::EmbeddedChart] - attr_accessor :chart - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @chart = args[:chart] if args.key?(:chart) - end - end - - # Inserts rows or columns in a sheet at a particular index. - class InsertDimensionRequest - include Google::Apis::Core::Hashable - - # Whether dimension properties should be extended from the dimensions - # before or after the newly inserted dimensions. - # True to inherit from the dimensions before (in which case the start - # index must be greater than 0), and false to inherit from the dimensions - # after. - # For example, if row index 0 has red background and row index 1 - # has a green background, then inserting 2 rows at index 1 can inherit - # either the green or red background. If `inheritFromBefore` is true, - # the two new rows will be red (because the row before the insertion point - # was red), whereas if `inheritFromBefore` is false, the two new rows will - # be green (because the row after the insertion point was green). - # Corresponds to the JSON property `inheritFromBefore` - # @return [Boolean] - attr_accessor :inherit_from_before - alias_method :inherit_from_before?, :inherit_from_before - - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::DimensionRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inherit_from_before = args[:inherit_from_before] if args.key?(:inherit_from_before) - @range = args[:range] if args.key?(:range) - end - end - - # Updates properties of a spreadsheet. - class UpdateSpreadsheetPropertiesRequest - include Google::Apis::Core::Hashable - - # The fields that should be updated. At least one field must be specified. - # The root 'properties' is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # Properties of a spreadsheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SpreadsheetProperties] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @fields = args[:fields] if args.key?(:fields) - @properties = args[:properties] if args.key?(:properties) - end - end - - # The request for updating more than one range of values in a spreadsheet. - class BatchUpdateValuesRequest - include Google::Apis::Core::Hashable - - # How the input data should be interpreted. - # Corresponds to the JSON property `valueInputOption` - # @return [String] - attr_accessor :value_input_option - - # The new values to apply to the spreadsheet. - # Corresponds to the JSON property `data` - # @return [Array] - attr_accessor :data - - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. - # Corresponds to the JSON property `responseDateTimeRenderOption` - # @return [String] - attr_accessor :response_date_time_render_option - - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. - # Corresponds to the JSON property `responseValueRenderOption` - # @return [String] - attr_accessor :response_value_render_option - - # Determines if the update response should include the values - # of the cells that were updated. By default, responses - # do not include the updated values. The `updatedData` field within - # each of the BatchUpdateValuesResponse.responses will contain - # the updated values. If the range to write was larger than than the range - # actually written, the response will include all values in the requested - # range (excluding trailing empty rows and columns). - # Corresponds to the JSON property `includeValuesInResponse` - # @return [Boolean] - attr_accessor :include_values_in_response - alias_method :include_values_in_response?, :include_values_in_response - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @value_input_option = args[:value_input_option] if args.key?(:value_input_option) - @data = args[:data] if args.key?(:data) - @response_date_time_render_option = args[:response_date_time_render_option] if args.key?(:response_date_time_render_option) - @response_value_render_option = args[:response_value_render_option] if args.key?(:response_value_render_option) - @include_values_in_response = args[:include_values_in_response] if args.key?(:include_values_in_response) - end - end - - # A protected range. - class ProtectedRange - include Google::Apis::Core::Hashable - - # True if the user who requested this protected range can edit the - # protected area. - # This field is read-only. - # Corresponds to the JSON property `requestingUserCanEdit` - # @return [Boolean] - attr_accessor :requesting_user_can_edit - alias_method :requesting_user_can_edit?, :requesting_user_can_edit - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # The editors of a protected range. - # Corresponds to the JSON property `editors` - # @return [Google::Apis::SheetsV4::Editors] - attr_accessor :editors - - # The description of this protected range. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The list of unprotected ranges within a protected sheet. - # Unprotected ranges are only supported on protected sheets. - # Corresponds to the JSON property `unprotectedRanges` - # @return [Array] - attr_accessor :unprotected_ranges - - # The named range this protected range is backed by, if any. - # When writing, only one of range or named_range_id - # may be set. - # Corresponds to the JSON property `namedRangeId` - # @return [String] - attr_accessor :named_range_id - - # The ID of the protected range. - # This field is read-only. - # Corresponds to the JSON property `protectedRangeId` - # @return [Fixnum] - attr_accessor :protected_range_id - - # True if this protected range will show a warning when editing. - # Warning-based protection means that every user can edit data in the - # protected range, except editing will prompt a warning asking the user - # to confirm the edit. - # When writing: if this field is true, then editors is ignored. - # Additionally, if this field is changed from true to false and the - # `editors` field is not set (nor included in the field mask), then - # the editors will be set to all the editors in the document. - # Corresponds to the JSON property `warningOnly` - # @return [Boolean] - attr_accessor :warning_only - alias_method :warning_only?, :warning_only - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @requesting_user_can_edit = args[:requesting_user_can_edit] if args.key?(:requesting_user_can_edit) - @range = args[:range] if args.key?(:range) - @editors = args[:editors] if args.key?(:editors) - @description = args[:description] if args.key?(:description) - @unprotected_ranges = args[:unprotected_ranges] if args.key?(:unprotected_ranges) - @named_range_id = args[:named_range_id] if args.key?(:named_range_id) - @protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id) - @warning_only = args[:warning_only] if args.key?(:warning_only) - end - end - - # Properties about a dimension. - class DimensionProperties - include Google::Apis::Core::Hashable - - # The height (if a row) or width (if a column) of the dimension in pixels. - # Corresponds to the JSON property `pixelSize` - # @return [Fixnum] - attr_accessor :pixel_size - - # True if this dimension is being filtered. - # This field is read-only. - # Corresponds to the JSON property `hiddenByFilter` - # @return [Boolean] - attr_accessor :hidden_by_filter - alias_method :hidden_by_filter?, :hidden_by_filter - - # True if this dimension is explicitly hidden. - # Corresponds to the JSON property `hiddenByUser` - # @return [Boolean] - attr_accessor :hidden_by_user - alias_method :hidden_by_user?, :hidden_by_user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pixel_size = args[:pixel_size] if args.key?(:pixel_size) - @hidden_by_filter = args[:hidden_by_filter] if args.key?(:hidden_by_filter) - @hidden_by_user = args[:hidden_by_user] if args.key?(:hidden_by_user) - end - end - - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. - class DimensionRange - include Google::Apis::Core::Hashable - - # The sheet this span is on. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # The dimension of the span. - # Corresponds to the JSON property `dimension` - # @return [String] - attr_accessor :dimension - - # The start (inclusive) of the span, or not set if unbounded. - # Corresponds to the JSON property `startIndex` - # @return [Fixnum] - attr_accessor :start_index - - # The end (exclusive) of the span, or not set if unbounded. - # Corresponds to the JSON property `endIndex` - # @return [Fixnum] - attr_accessor :end_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - @dimension = args[:dimension] if args.key?(:dimension) - @start_index = args[:start_index] if args.key?(:start_index) - @end_index = args[:end_index] if args.key?(:end_index) - end - end - - # A named range. - class NamedRange - include Google::Apis::Core::Hashable - - # The name of the named range. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The ID of the named range. - # Corresponds to the JSON property `namedRangeId` - # @return [String] - attr_accessor :named_range_id - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @named_range_id = args[:named_range_id] if args.key?(:named_range_id) - @range = args[:range] if args.key?(:range) - end - end - - # Moves data from the source to the destination. - class CutPasteRequest - include Google::Apis::Core::Hashable - - # A coordinate in a sheet. - # All indexes are zero-based. - # Corresponds to the JSON property `destination` - # @return [Google::Apis::SheetsV4::GridCoordinate] - attr_accessor :destination - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `source` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :source - - # What kind of data to paste. All the source data will be cut, regardless - # of what is pasted. - # Corresponds to the JSON property `pasteType` - # @return [String] - attr_accessor :paste_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @destination = args[:destination] if args.key?(:destination) - @source = args[:source] if args.key?(:source) - @paste_type = args[:paste_type] if args.key?(:paste_type) - end - end - - # A single series of data in a chart. - # For example, if charting stock prices over time, multiple series may exist, - # one for the "Open Price", "High Price", "Low Price" and "Close Price". - class BasicChartSeries - include Google::Apis::Core::Hashable - - # The data included in a domain or series. - # Corresponds to the JSON property `series` - # @return [Google::Apis::SheetsV4::ChartData] - attr_accessor :series - - # The type of this series. Valid only if the - # chartType is - # COMBO. - # Different types will change the way the series is visualized. - # Only LINE, AREA, - # and COLUMN are supported. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # The minor axis that will specify the range of values for this series. - # For example, if charting stocks over time, the "Volume" series - # may want to be pinned to the right with the prices pinned to the left, - # because the scale of trading volume is different than the scale of - # prices. - # It is an error to specify an axis that isn't a valid minor axis - # for the chart's type. - # Corresponds to the JSON property `targetAxis` - # @return [String] - attr_accessor :target_axis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @series = args[:series] if args.key?(:series) - @type = args[:type] if args.key?(:type) - @target_axis = args[:target_axis] if args.key?(:target_axis) - end - end - - # The borders of the cell. - class Borders - include Google::Apis::Core::Hashable - - # A border along a cell. - # Corresponds to the JSON property `right` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :right - - # A border along a cell. - # Corresponds to the JSON property `bottom` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :bottom - - # A border along a cell. - # Corresponds to the JSON property `top` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :top - - # A border along a cell. - # Corresponds to the JSON property `left` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :left - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @right = args[:right] if args.key?(:right) - @bottom = args[:bottom] if args.key?(:bottom) - @top = args[:top] if args.key?(:top) - @left = args[:left] if args.key?(:left) - end - end - - # Automatically resizes one or more dimensions based on the contents - # of the cells in that dimension. - class AutoResizeDimensionsRequest - include Google::Apis::Core::Hashable - - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. - # Corresponds to the JSON property `dimensions` - # @return [Google::Apis::SheetsV4::DimensionRange] - attr_accessor :dimensions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dimensions = args[:dimensions] if args.key?(:dimensions) - end - end - - # Updates the borders of a range. - # If a field is not set in the request, that means the border remains as-is. - # For example, with two subsequent UpdateBordersRequest: - # 1. range: A1:A5 `` top: RED, bottom: WHITE `` - # 2. range: A1:A5 `` left: BLUE `` - # That would result in A1:A5 having a borders of - # `` top: RED, bottom: WHITE, left: BLUE ``. - # If you want to clear a border, explicitly set the style to - # NONE. - class UpdateBordersRequest - include Google::Apis::Core::Hashable - - # A border along a cell. - # Corresponds to the JSON property `bottom` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :bottom - - # A border along a cell. - # Corresponds to the JSON property `innerVertical` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :inner_vertical - - # A border along a cell. - # Corresponds to the JSON property `right` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :right - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # A border along a cell. - # Corresponds to the JSON property `innerHorizontal` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :inner_horizontal - - # A border along a cell. - # Corresponds to the JSON property `top` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :top - - # A border along a cell. - # Corresponds to the JSON property `left` - # @return [Google::Apis::SheetsV4::Border] - attr_accessor :left - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bottom = args[:bottom] if args.key?(:bottom) - @inner_vertical = args[:inner_vertical] if args.key?(:inner_vertical) - @right = args[:right] if args.key?(:right) - @range = args[:range] if args.key?(:range) - @inner_horizontal = args[:inner_horizontal] if args.key?(:inner_horizontal) - @top = args[:top] if args.key?(:top) - @left = args[:left] if args.key?(:left) - end - end - - # The format of a cell. - class CellFormat - include Google::Apis::Core::Hashable - - # The vertical alignment of the value in the cell. - # Corresponds to the JSON property `verticalAlignment` - # @return [String] - attr_accessor :vertical_alignment - - # The amount of padding around the cell, in pixels. - # When updating padding, every field must be specified. - # Corresponds to the JSON property `padding` - # @return [Google::Apis::SheetsV4::Padding] - attr_accessor :padding - - # The borders of the cell. - # Corresponds to the JSON property `borders` - # @return [Google::Apis::SheetsV4::Borders] - attr_accessor :borders - - # The direction of the text in the cell. - # Corresponds to the JSON property `textDirection` - # @return [String] - attr_accessor :text_direction - - # The wrap strategy for the value in the cell. - # Corresponds to the JSON property `wrapStrategy` - # @return [String] - attr_accessor :wrap_strategy - - # The number format of a cell. - # Corresponds to the JSON property `numberFormat` - # @return [Google::Apis::SheetsV4::NumberFormat] - attr_accessor :number_format - - # The horizontal alignment of the value in the cell. - # Corresponds to the JSON property `horizontalAlignment` - # @return [String] - attr_accessor :horizontal_alignment - - # How a hyperlink, if it exists, should be displayed in the cell. - # Corresponds to the JSON property `hyperlinkDisplayType` - # @return [String] - attr_accessor :hyperlink_display_type - - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. - # Corresponds to the JSON property `textFormat` - # @return [Google::Apis::SheetsV4::TextFormat] - attr_accessor :text_format - - # Represents a color in the RGBA color space. This representation is designed - # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. Here are some examples: - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... - # Corresponds to the JSON property `backgroundColor` - # @return [Google::Apis::SheetsV4::Color] - attr_accessor :background_color - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @vertical_alignment = args[:vertical_alignment] if args.key?(:vertical_alignment) - @padding = args[:padding] if args.key?(:padding) - @borders = args[:borders] if args.key?(:borders) - @text_direction = args[:text_direction] if args.key?(:text_direction) - @wrap_strategy = args[:wrap_strategy] if args.key?(:wrap_strategy) - @number_format = args[:number_format] if args.key?(:number_format) - @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) - @hyperlink_display_type = args[:hyperlink_display_type] if args.key?(:hyperlink_display_type) - @text_format = args[:text_format] if args.key?(:text_format) - @background_color = args[:background_color] if args.key?(:background_color) - end - end - - # The response when clearing a range of values in a spreadsheet. - class ClearValuesResponse - include Google::Apis::Core::Hashable - - # The spreadsheet the updates were applied to. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - # The range (in A1 notation) that was cleared. - # (If the request was for an unbounded range or a ranger larger - # than the bounds of the sheet, this will be the actual range - # that was cleared, bounded to the sheet's limits.) - # Corresponds to the JSON property `clearedRange` - # @return [String] - attr_accessor :cleared_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - @cleared_range = args[:cleared_range] if args.key?(:cleared_range) - end - end - - # Deletes a conditional format rule at the given index. - # All subsequent rules' indexes are decremented. - class DeleteConditionalFormatRuleRequest - include Google::Apis::Core::Hashable - - # The zero-based index of the rule to be deleted. - # Corresponds to the JSON property `index` - # @return [Fixnum] - attr_accessor :index - - # The sheet the rule is being deleted from. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @index = args[:index] if args.key?(:index) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - end - end - - # Removes the named range with the given ID from the spreadsheet. - class DeleteNamedRangeRequest - include Google::Apis::Core::Hashable - - # The ID of the named range to delete. - # Corresponds to the JSON property `namedRangeId` - # @return [String] - attr_accessor :named_range_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @named_range_id = args[:named_range_id] if args.key?(:named_range_id) - end - end - - # The result of adding a banded range. - class AddBandingResponse - include Google::Apis::Core::Hashable - - # A banded (alternating colors) range in a sheet. - # Corresponds to the JSON property `bandedRange` - # @return [Google::Apis::SheetsV4::BandedRange] - attr_accessor :banded_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @banded_range = args[:banded_range] if args.key?(:banded_range) - end - end - - # The data included in a domain or series. - class ChartData - include Google::Apis::Core::Hashable - - # Source ranges for a chart. - # Corresponds to the JSON property `sourceRange` - # @return [Google::Apis::SheetsV4::ChartSourceRange] - attr_accessor :source_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @source_range = args[:source_range] if args.key?(:source_range) - end - end - - # The response when retrieving more than one range of values in a spreadsheet. - class BatchGetValuesResponse - include Google::Apis::Core::Hashable - - # The ID of the spreadsheet the data was retrieved from. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - # The requested values. The order of the ValueRanges is the same as the - # order of the requested ranges. - # Corresponds to the JSON property `valueRanges` - # @return [Array] - attr_accessor :value_ranges - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - @value_ranges = args[:value_ranges] if args.key?(:value_ranges) - end - end - - # Updates properties of the supplied banded range. - class UpdateBandingRequest - include Google::Apis::Core::Hashable - - # The fields that should be updated. At least one field must be specified. - # The root `bandedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # A banded (alternating colors) range in a sheet. - # Corresponds to the JSON property `bandedRange` - # @return [Google::Apis::SheetsV4::BandedRange] - attr_accessor :banded_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @fields = args[:fields] if args.key?(:fields) - @banded_range = args[:banded_range] if args.key?(:banded_range) - end - end - - # Represents a color in the RGBA color space. This representation is designed - # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. Here are some examples: - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... - class Color - include Google::Apis::Core::Hashable - - # The amount of red in the color as a value in the interval [0, 1]. - # Corresponds to the JSON property `red` - # @return [Float] - attr_accessor :red - - # The amount of green in the color as a value in the interval [0, 1]. - # Corresponds to the JSON property `green` - # @return [Float] - attr_accessor :green - - # The amount of blue in the color as a value in the interval [0, 1]. - # Corresponds to the JSON property `blue` - # @return [Float] - attr_accessor :blue - - # The fraction of this color that should be applied to the pixel. That is, - # the final pixel color is defined by the equation: - # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) - # This means that a value of 1.0 corresponds to a solid color, whereas - # a value of 0.0 corresponds to a completely transparent color. This - # uses a wrapper message rather than a simple float scalar so that it is - # possible to distinguish between a default value and the value being unset. - # If omitted, this color object is to be rendered as a solid color - # (as if the alpha value had been explicitly given with a value of 1.0). - # Corresponds to the JSON property `alpha` - # @return [Float] - attr_accessor :alpha - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @red = args[:red] if args.key?(:red) - @green = args[:green] if args.key?(:green) - @blue = args[:blue] if args.key?(:blue) - @alpha = args[:alpha] if args.key?(:alpha) - end - end - - # A single grouping (either row or column) in a pivot table. - class PivotGroup - include Google::Apis::Core::Hashable - - # The order the values in this group should be sorted. - # Corresponds to the JSON property `sortOrder` - # @return [String] - attr_accessor :sort_order - - # Information about which values in a pivot group should be used for sorting. - # Corresponds to the JSON property `valueBucket` - # @return [Google::Apis::SheetsV4::PivotGroupSortValueBucket] - attr_accessor :value_bucket - - # The column offset of the source range that this grouping is based on. - # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` - # means this group refers to column `C`, whereas the offset `1` would refer - # to column `D`. - # Corresponds to the JSON property `sourceColumnOffset` - # @return [Fixnum] - attr_accessor :source_column_offset - - # True if the pivot table should include the totals for this grouping. - # Corresponds to the JSON property `showTotals` - # @return [Boolean] - attr_accessor :show_totals - alias_method :show_totals?, :show_totals - - # Metadata about values in the grouping. - # Corresponds to the JSON property `valueMetadata` - # @return [Array] - attr_accessor :value_metadata - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sort_order = args[:sort_order] if args.key?(:sort_order) - @value_bucket = args[:value_bucket] if args.key?(:value_bucket) - @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset) - @show_totals = args[:show_totals] if args.key?(:show_totals) - @value_metadata = args[:value_metadata] if args.key?(:value_metadata) - end - end - - # A pivot table. - class PivotTable - include Google::Apis::Core::Hashable - - # Each row grouping in the pivot table. - # Corresponds to the JSON property `rows` - # @return [Array] - attr_accessor :rows - - # Whether values should be listed horizontally (as columns) - # or vertically (as rows). - # Corresponds to the JSON property `valueLayout` - # @return [String] - attr_accessor :value_layout - - # Each column grouping in the pivot table. - # Corresponds to the JSON property `columns` - # @return [Array] - attr_accessor :columns - - # A list of values to include in the pivot table. - # Corresponds to the JSON property `values` - # @return [Array] - attr_accessor :values - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `source` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :source - - # An optional mapping of filters per source column offset. - # The filters will be applied before aggregating data into the pivot table. - # The map's key is the column offset of the source range that you want to - # filter, and the value is the criteria for that column. - # For example, if the source was `C10:E15`, a key of `0` will have the filter - # for column `C`, whereas the key `1` is for column `D`. - # Corresponds to the JSON property `criteria` - # @return [Hash] - attr_accessor :criteria - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rows = args[:rows] if args.key?(:rows) - @value_layout = args[:value_layout] if args.key?(:value_layout) - @columns = args[:columns] if args.key?(:columns) - @values = args[:values] if args.key?(:values) - @source = args[:source] if args.key?(:source) - @criteria = args[:criteria] if args.key?(:criteria) - end - end - - # Source ranges for a chart. - class ChartSourceRange - include Google::Apis::Core::Hashable - - # The ranges of data for a series or domain. - # Exactly one dimension must have a length of 1, - # and all sources in the list must have the same dimension - # with length 1. - # The domain (if it exists) & all series must have the same number - # of source ranges. If using more than one source range, then the source - # range at a given offset must be contiguous across the domain and series. - # For example, these are valid configurations: - # domain sources: A1:A5 - # series1 sources: B1:B5 - # series2 sources: D6:D10 - # domain sources: A1:A5, C10:C12 - # series1 sources: B1:B5, D10:D12 - # series2 sources: C1:C5, E10:E12 - # Corresponds to the JSON property `sources` - # @return [Array] - attr_accessor :sources - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sources = args[:sources] if args.key?(:sources) - end - end - - # Adds new cells after the last row with data in a sheet, - # inserting new rows into the sheet if necessary. - class AppendCellsRequest - include Google::Apis::Core::Hashable - - # The data to append. - # Corresponds to the JSON property `rows` - # @return [Array] - attr_accessor :rows - - # The fields of CellData that should be updated. - # At least one field must be specified. - # The root is the CellData; 'row.values.' should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # The sheet ID to append the data to. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rows = args[:rows] if args.key?(:rows) - @fields = args[:fields] if args.key?(:fields) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - end - end - - # Data within a range of the spreadsheet. - class ValueRange - include Google::Apis::Core::Hashable - - # The major dimension of the values. - # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, - # then requesting `range=A1:B2,majorDimension=ROWS` will return - # `[[1,2],[3,4]]`, - # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return - # `[[1,3],[2,4]]`. - # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` - # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` - # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. - # When writing, if this field is not set, it defaults to ROWS. - # Corresponds to the JSON property `majorDimension` - # @return [String] - attr_accessor :major_dimension - - # The data that was read or to be written. This is an array of arrays, - # the outer array representing all the data and each inner array - # representing a major dimension. Each item in the inner array - # corresponds with one cell. - # For output, empty trailing rows and columns will not be included. - # For input, supported value types are: bool, string, and double. - # Null values will be skipped. - # To set a cell to an empty value, set the string value to an empty string. - # Corresponds to the JSON property `values` - # @return [Array>] - attr_accessor :values - - # The range the values cover, in A1 notation. - # For output, this range indicates the entire requested range, - # even though the values will exclude trailing rows and columns. - # When appending values, this field represents the range to search for a - # table, after which values will be appended. - # Corresponds to the JSON property `range` - # @return [String] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @major_dimension = args[:major_dimension] if args.key?(:major_dimension) - @values = args[:values] if args.key?(:values) - @range = args[:range] if args.key?(:range) - end - end - - # Adds a new banded range to the spreadsheet. - class AddBandingRequest - include Google::Apis::Core::Hashable - - # A banded (alternating colors) range in a sheet. - # Corresponds to the JSON property `bandedRange` - # @return [Google::Apis::SheetsV4::BandedRange] - attr_accessor :banded_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @banded_range = args[:banded_range] if args.key?(:banded_range) - end - end - - # A single response from an update. - class Response - include Google::Apis::Core::Hashable - - # The result of adding a filter view. - # Corresponds to the JSON property `addFilterView` - # @return [Google::Apis::SheetsV4::AddFilterViewResponse] - attr_accessor :add_filter_view - - # The result of adding a banded range. - # Corresponds to the JSON property `addBanding` - # @return [Google::Apis::SheetsV4::AddBandingResponse] - attr_accessor :add_banding - - # The result of adding a new protected range. - # Corresponds to the JSON property `addProtectedRange` - # @return [Google::Apis::SheetsV4::AddProtectedRangeResponse] - attr_accessor :add_protected_range - - # The result of duplicating a sheet. - # Corresponds to the JSON property `duplicateSheet` - # @return [Google::Apis::SheetsV4::DuplicateSheetResponse] - attr_accessor :duplicate_sheet - - # The result of updating an embedded object's position. - # Corresponds to the JSON property `updateEmbeddedObjectPosition` - # @return [Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse] - attr_accessor :update_embedded_object_position - - # The result of deleting a conditional format rule. - # Corresponds to the JSON property `deleteConditionalFormatRule` - # @return [Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse] - attr_accessor :delete_conditional_format_rule - - # The result of a filter view being duplicated. - # Corresponds to the JSON property `duplicateFilterView` - # @return [Google::Apis::SheetsV4::DuplicateFilterViewResponse] - attr_accessor :duplicate_filter_view - - # The result of adding a chart to a spreadsheet. - # Corresponds to the JSON property `addChart` - # @return [Google::Apis::SheetsV4::AddChartResponse] - attr_accessor :add_chart - - # The result of the find/replace. - # Corresponds to the JSON property `findReplace` - # @return [Google::Apis::SheetsV4::FindReplaceResponse] - attr_accessor :find_replace - - # The result of adding a sheet. - # Corresponds to the JSON property `addSheet` - # @return [Google::Apis::SheetsV4::AddSheetResponse] - attr_accessor :add_sheet - - # The result of updating a conditional format rule. - # Corresponds to the JSON property `updateConditionalFormatRule` - # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse] - attr_accessor :update_conditional_format_rule - - # The result of adding a named range. - # Corresponds to the JSON property `addNamedRange` - # @return [Google::Apis::SheetsV4::AddNamedRangeResponse] - attr_accessor :add_named_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @add_filter_view = args[:add_filter_view] if args.key?(:add_filter_view) - @add_banding = args[:add_banding] if args.key?(:add_banding) - @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range) - @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet) - @update_embedded_object_position = args[:update_embedded_object_position] if args.key?(:update_embedded_object_position) - @delete_conditional_format_rule = args[:delete_conditional_format_rule] if args.key?(:delete_conditional_format_rule) - @duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view) - @add_chart = args[:add_chart] if args.key?(:add_chart) - @find_replace = args[:find_replace] if args.key?(:find_replace) - @add_sheet = args[:add_sheet] if args.key?(:add_sheet) - @update_conditional_format_rule = args[:update_conditional_format_rule] if args.key?(:update_conditional_format_rule) - @add_named_range = args[:add_named_range] if args.key?(:add_named_range) - end - end - - # Inserts cells into a range, shifting the existing cells over or down. - class InsertRangeRequest - include Google::Apis::Core::Hashable - - # The dimension which will be shifted when inserting cells. - # If ROWS, existing cells will be shifted down. - # If COLUMNS, existing cells will be shifted right. - # Corresponds to the JSON property `shiftDimension` - # @return [String] - attr_accessor :shift_dimension - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @shift_dimension = args[:shift_dimension] if args.key?(:shift_dimension) - @range = args[:range] if args.key?(:range) - end - end - - # A chart embedded in a sheet. - class EmbeddedChart - include Google::Apis::Core::Hashable - - # The ID of the chart. - # Corresponds to the JSON property `chartId` - # @return [Fixnum] - attr_accessor :chart_id - - # The position of an embedded object such as a chart. - # Corresponds to the JSON property `position` - # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] - attr_accessor :position - - # The specifications of a chart. - # Corresponds to the JSON property `spec` - # @return [Google::Apis::SheetsV4::ChartSpec] - attr_accessor :spec - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @chart_id = args[:chart_id] if args.key?(:chart_id) - @position = args[:position] if args.key?(:position) - @spec = args[:spec] if args.key?(:spec) - end - end - - # A run of a text format. The format of this run continues until the start - # index of the next run. - # When updating, all fields must be set. - class TextFormatRun - include Google::Apis::Core::Hashable - - # The character index where this run starts. - # Corresponds to the JSON property `startIndex` - # @return [Fixnum] - attr_accessor :start_index - - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. - # Corresponds to the JSON property `format` - # @return [Google::Apis::SheetsV4::TextFormat] - attr_accessor :format - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @start_index = args[:start_index] if args.key?(:start_index) - @format = args[:format] if args.key?(:format) - end - end - - # The result of adding a named range. - class AddNamedRangeResponse - include Google::Apis::Core::Hashable - - # A named range. - # Corresponds to the JSON property `namedRange` - # @return [Google::Apis::SheetsV4::NamedRange] - attr_accessor :named_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @named_range = args[:named_range] if args.key?(:named_range) - end - end - - # Data about each cell in a row. - class RowData - include Google::Apis::Core::Hashable - - # The values in the row, one per column. - # Corresponds to the JSON property `values` - # @return [Array] - attr_accessor :values - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @values = args[:values] if args.key?(:values) - end - end - - # Data in the grid, as well as metadata about the dimensions. - class GridData - include Google::Apis::Core::Hashable - - # The data in the grid, one entry per row, - # starting with the row in startRow. - # The values in RowData will correspond to columns starting - # at start_column. - # Corresponds to the JSON property `rowData` - # @return [Array] - attr_accessor :row_data - - # The first row this GridData refers to, zero-based. - # Corresponds to the JSON property `startRow` - # @return [Fixnum] - attr_accessor :start_row - - # Metadata about the requested columns in the grid, starting with the column - # in start_column. - # Corresponds to the JSON property `columnMetadata` - # @return [Array] - attr_accessor :column_metadata - - # The first column this GridData refers to, zero-based. - # Corresponds to the JSON property `startColumn` - # @return [Fixnum] - attr_accessor :start_column - - # Metadata about the requested rows in the grid, starting with the row - # in start_row. - # Corresponds to the JSON property `rowMetadata` - # @return [Array] - attr_accessor :row_metadata - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @row_data = args[:row_data] if args.key?(:row_data) - @start_row = args[:start_row] if args.key?(:start_row) - @column_metadata = args[:column_metadata] if args.key?(:column_metadata) - @start_column = args[:start_column] if args.key?(:start_column) - @row_metadata = args[:row_metadata] if args.key?(:row_metadata) - end - end - - # A border along a cell. - class Border - include Google::Apis::Core::Hashable - - # Represents a color in the RGBA color space. This representation is designed - # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. Here are some examples: - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... - # Corresponds to the JSON property `color` - # @return [Google::Apis::SheetsV4::Color] - attr_accessor :color - - # The width of the border, in pixels. - # Deprecated; the width is determined by the "style" field. - # Corresponds to the JSON property `width` - # @return [Fixnum] - attr_accessor :width - - # The style of the border. - # Corresponds to the JSON property `style` - # @return [String] - attr_accessor :style - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @color = args[:color] if args.key?(:color) - @width = args[:width] if args.key?(:width) - @style = args[:style] if args.key?(:style) - end - end - - # Updates properties of the named range with the specified - # namedRangeId. - class UpdateNamedRangeRequest - include Google::Apis::Core::Hashable - - # A named range. - # Corresponds to the JSON property `namedRange` - # @return [Google::Apis::SheetsV4::NamedRange] - attr_accessor :named_range - - # The fields that should be updated. At least one field must be specified. - # The root `namedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @named_range = args[:named_range] if args.key?(:named_range) - @fields = args[:fields] if args.key?(:fields) - end - end - - # Finds and replaces data in cells over a range, sheet, or all sheets. - class FindReplaceRequest - include Google::Apis::Core::Hashable - - # True if the find value should match the entire cell. - # Corresponds to the JSON property `matchEntireCell` - # @return [Boolean] - attr_accessor :match_entire_cell - alias_method :match_entire_cell?, :match_entire_cell - - # True if the find value is a regex. - # The regular expression and replacement should follow Java regex rules - # at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. - # The replacement string is allowed to refer to capturing groups. - # For example, if one cell has the contents `"Google Sheets"` and another - # has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of - # `"$1 Rocks"` would change the contents of the cells to - # `"GSheets Rocks"` and `"GDocs Rocks"` respectively. - # Corresponds to the JSON property `searchByRegex` - # @return [Boolean] - attr_accessor :search_by_regex - alias_method :search_by_regex?, :search_by_regex - - # The value to search. - # Corresponds to the JSON property `find` - # @return [String] - attr_accessor :find - - # The value to use as the replacement. - # Corresponds to the JSON property `replacement` - # @return [String] - attr_accessor :replacement - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # The sheet to find/replace over. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # True to find/replace over all sheets. - # Corresponds to the JSON property `allSheets` - # @return [Boolean] - attr_accessor :all_sheets - alias_method :all_sheets?, :all_sheets - - # True if the search is case sensitive. - # Corresponds to the JSON property `matchCase` - # @return [Boolean] - attr_accessor :match_case - alias_method :match_case?, :match_case - - # True if the search should include cells with formulas. - # False to skip cells with formulas. - # Corresponds to the JSON property `includeFormulas` - # @return [Boolean] - attr_accessor :include_formulas - alias_method :include_formulas?, :include_formulas - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @match_entire_cell = args[:match_entire_cell] if args.key?(:match_entire_cell) - @search_by_regex = args[:search_by_regex] if args.key?(:search_by_regex) - @find = args[:find] if args.key?(:find) - @replacement = args[:replacement] if args.key?(:replacement) - @range = args[:range] if args.key?(:range) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - @all_sheets = args[:all_sheets] if args.key?(:all_sheets) - @match_case = args[:match_case] if args.key?(:match_case) - @include_formulas = args[:include_formulas] if args.key?(:include_formulas) - end - end - - # Adds a new sheet. - # When a sheet is added at a given index, - # all subsequent sheets' indexes are incremented. - # To add an object sheet, use AddChartRequest instead and specify - # EmbeddedObjectPosition.sheetId or - # EmbeddedObjectPosition.newSheet. - class AddSheetRequest - include Google::Apis::Core::Hashable - - # Properties of a sheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SheetProperties] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @properties = args[:properties] if args.key?(:properties) - end - end - - # Updates all cells in a range with new data. - class UpdateCellsRequest - include Google::Apis::Core::Hashable - - # The data to write. - # Corresponds to the JSON property `rows` - # @return [Array] - attr_accessor :rows - - # The fields of CellData that should be updated. - # At least one field must be specified. - # The root is the CellData; 'row.values.' should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # A coordinate in a sheet. - # All indexes are zero-based. - # Corresponds to the JSON property `start` - # @return [Google::Apis::SheetsV4::GridCoordinate] - attr_accessor :start - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rows = args[:rows] if args.key?(:rows) - @fields = args[:fields] if args.key?(:fields) - @start = args[:start] if args.key?(:start) - @range = args[:range] if args.key?(:range) - end - end - - # The result of deleting a conditional format rule. - class DeleteConditionalFormatRuleResponse - include Google::Apis::Core::Hashable - - # A rule describing a conditional format. - # Corresponds to the JSON property `rule` - # @return [Google::Apis::SheetsV4::ConditionalFormatRule] - attr_accessor :rule - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rule = args[:rule] if args.key?(:rule) - end - end - - # Deletes a range of cells, shifting other cells into the deleted area. - class DeleteRangeRequest - include Google::Apis::Core::Hashable - - # The dimension from which deleted cells will be replaced with. - # If ROWS, existing cells will be shifted upward to - # replace the deleted cells. If COLUMNS, existing cells - # will be shifted left to replace the deleted cells. - # Corresponds to the JSON property `shiftDimension` - # @return [String] - attr_accessor :shift_dimension - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @shift_dimension = args[:shift_dimension] if args.key?(:shift_dimension) - @range = args[:range] if args.key?(:range) - end - end - - # A coordinate in a sheet. - # All indexes are zero-based. - class GridCoordinate - include Google::Apis::Core::Hashable - - # The sheet this coordinate is on. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # The row index of the coordinate. - # Corresponds to the JSON property `rowIndex` - # @return [Fixnum] - attr_accessor :row_index - - # The column index of the coordinate. - # Corresponds to the JSON property `columnIndex` - # @return [Fixnum] - attr_accessor :column_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - @row_index = args[:row_index] if args.key?(:row_index) - @column_index = args[:column_index] if args.key?(:column_index) - end - end - - # Updates properties of the sheet with the specified - # sheetId. - class UpdateSheetPropertiesRequest - include Google::Apis::Core::Hashable - - # The fields that should be updated. At least one field must be specified. - # The root `properties` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # Properties of a sheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SheetProperties] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @fields = args[:fields] if args.key?(:fields) - @properties = args[:properties] if args.key?(:properties) - end - end - - # Unmerges cells in the given range. - class UnmergeCellsRequest - include Google::Apis::Core::Hashable - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @range = args[:range] if args.key?(:range) - end - end - - # Properties of a grid. - class GridProperties - include Google::Apis::Core::Hashable - - # The number of rows in the grid. - # Corresponds to the JSON property `rowCount` - # @return [Fixnum] - attr_accessor :row_count - - # The number of rows that are frozen in the grid. - # Corresponds to the JSON property `frozenRowCount` - # @return [Fixnum] - attr_accessor :frozen_row_count - - # True if the grid isn't showing gridlines in the UI. - # Corresponds to the JSON property `hideGridlines` - # @return [Boolean] - attr_accessor :hide_gridlines - alias_method :hide_gridlines?, :hide_gridlines - - # The number of columns in the grid. - # Corresponds to the JSON property `columnCount` - # @return [Fixnum] - attr_accessor :column_count - - # The number of columns that are frozen in the grid. - # Corresponds to the JSON property `frozenColumnCount` - # @return [Fixnum] - attr_accessor :frozen_column_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @row_count = args[:row_count] if args.key?(:row_count) - @frozen_row_count = args[:frozen_row_count] if args.key?(:frozen_row_count) - @hide_gridlines = args[:hide_gridlines] if args.key?(:hide_gridlines) - @column_count = args[:column_count] if args.key?(:column_count) - @frozen_column_count = args[:frozen_column_count] if args.key?(:frozen_column_count) - end - end - - # The result of updating an embedded object's position. - class UpdateEmbeddedObjectPositionResponse - include Google::Apis::Core::Hashable - - # The position of an embedded object such as a chart. - # Corresponds to the JSON property `position` - # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] - attr_accessor :position - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @position = args[:position] if args.key?(:position) - end - end - - # A sort order associated with a specific column or row. - class SortSpec - include Google::Apis::Core::Hashable - - # The order data should be sorted. - # Corresponds to the JSON property `sortOrder` - # @return [String] - attr_accessor :sort_order - - # The dimension the sort should be applied to. - # Corresponds to the JSON property `dimensionIndex` - # @return [Fixnum] - attr_accessor :dimension_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sort_order = args[:sort_order] if args.key?(:sort_order) - @dimension_index = args[:dimension_index] if args.key?(:dimension_index) - end - end - - # A sheet in a spreadsheet. - class Sheet - include Google::Apis::Core::Hashable - - # Properties of a sheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SheetProperties] - attr_accessor :properties - - # The specifications of every chart on this sheet. - # Corresponds to the JSON property `charts` - # @return [Array] - attr_accessor :charts - - # The filter views in this sheet. - # Corresponds to the JSON property `filterViews` - # @return [Array] - attr_accessor :filter_views - - # The conditional format rules in this sheet. - # Corresponds to the JSON property `conditionalFormats` - # @return [Array] - attr_accessor :conditional_formats - - # The protected ranges in this sheet. - # Corresponds to the JSON property `protectedRanges` - # @return [Array] - attr_accessor :protected_ranges - - # The default filter associated with a sheet. - # Corresponds to the JSON property `basicFilter` - # @return [Google::Apis::SheetsV4::BasicFilter] - attr_accessor :basic_filter - - # The ranges that are merged together. - # Corresponds to the JSON property `merges` - # @return [Array] - attr_accessor :merges - - # Data in the grid, if this is a grid sheet. - # The number of GridData objects returned is dependent on the number of - # ranges requested on this sheet. For example, if this is representing - # `Sheet1`, and the spreadsheet was requested with ranges - # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a - # startRow/startColumn of `0`, - # while the second one will have `startRow 14` (zero-based row 15), - # and `startColumn 3` (zero-based column D). - # Corresponds to the JSON property `data` - # @return [Array] - attr_accessor :data - - # The banded (i.e. alternating colors) ranges on this sheet. - # Corresponds to the JSON property `bandedRanges` - # @return [Array] - attr_accessor :banded_ranges - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @properties = args[:properties] if args.key?(:properties) - @charts = args[:charts] if args.key?(:charts) - @filter_views = args[:filter_views] if args.key?(:filter_views) - @conditional_formats = args[:conditional_formats] if args.key?(:conditional_formats) - @protected_ranges = args[:protected_ranges] if args.key?(:protected_ranges) - @basic_filter = args[:basic_filter] if args.key?(:basic_filter) - @merges = args[:merges] if args.key?(:merges) - @data = args[:data] if args.key?(:data) - @banded_ranges = args[:banded_ranges] if args.key?(:banded_ranges) - end - end - - # A rule that may or may not match, depending on the condition. - class BooleanRule - include Google::Apis::Core::Hashable - - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. - # Corresponds to the JSON property `condition` - # @return [Google::Apis::SheetsV4::BooleanCondition] - attr_accessor :condition - - # The format of a cell. - # Corresponds to the JSON property `format` - # @return [Google::Apis::SheetsV4::CellFormat] - attr_accessor :format - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @condition = args[:condition] if args.key?(:condition) - @format = args[:format] if args.key?(:format) - end - end - - # Criteria for showing/hiding rows in a filter or filter view. - class FilterCriteria - include Google::Apis::Core::Hashable - - # Values that should be hidden. - # Corresponds to the JSON property `hiddenValues` - # @return [Array] - attr_accessor :hidden_values - - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. - # Corresponds to the JSON property `condition` - # @return [Google::Apis::SheetsV4::BooleanCondition] - attr_accessor :condition - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @hidden_values = args[:hidden_values] if args.key?(:hidden_values) - @condition = args[:condition] if args.key?(:condition) - end - end - - # Metadata about a value in a pivot grouping. - class PivotGroupValueMetadata - include Google::Apis::Core::Hashable - - # The kinds of value that a cell in a spreadsheet can have. - # Corresponds to the JSON property `value` - # @return [Google::Apis::SheetsV4::ExtendedValue] - attr_accessor :value - - # True if the data corresponding to the value is collapsed. - # Corresponds to the JSON property `collapsed` - # @return [Boolean] - attr_accessor :collapsed - alias_method :collapsed?, :collapsed - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @value = args[:value] if args.key?(:value) - @collapsed = args[:collapsed] if args.key?(:collapsed) - end - end - - # The editors of a protected range. - class Editors - include Google::Apis::Core::Hashable - - # The email addresses of users with edit access to the protected range. - # Corresponds to the JSON property `users` - # @return [Array] - attr_accessor :users - - # The email addresses of groups with edit access to the protected range. - # Corresponds to the JSON property `groups` - # @return [Array] - attr_accessor :groups - - # True if anyone in the document's domain has edit access to the protected - # range. Domain protection is only supported on documents within a domain. - # Corresponds to the JSON property `domainUsersCanEdit` - # @return [Boolean] - attr_accessor :domain_users_can_edit - alias_method :domain_users_can_edit?, :domain_users_can_edit - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @users = args[:users] if args.key?(:users) - @groups = args[:groups] if args.key?(:groups) - @domain_users_can_edit = args[:domain_users_can_edit] if args.key?(:domain_users_can_edit) - end - end - - # Updates a conditional format rule at the given index, - # or moves a conditional format rule to another index. - class UpdateConditionalFormatRuleRequest - include Google::Apis::Core::Hashable - - # A rule describing a conditional format. - # Corresponds to the JSON property `rule` - # @return [Google::Apis::SheetsV4::ConditionalFormatRule] - attr_accessor :rule - - # The zero-based index of the rule that should be replaced or moved. - # Corresponds to the JSON property `index` - # @return [Fixnum] - attr_accessor :index - - # The sheet of the rule to move. Required if new_index is set, - # unused otherwise. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # The zero-based new index the rule should end up at. - # Corresponds to the JSON property `newIndex` - # @return [Fixnum] - attr_accessor :new_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rule = args[:rule] if args.key?(:rule) - @index = args[:index] if args.key?(:index) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - @new_index = args[:new_index] if args.key?(:new_index) - end - end - - # A data validation rule. - class DataValidationRule - include Google::Apis::Core::Hashable - - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. - # Corresponds to the JSON property `condition` - # @return [Google::Apis::SheetsV4::BooleanCondition] - attr_accessor :condition - - # True if the UI should be customized based on the kind of condition. - # If true, "List" conditions will show a dropdown. - # Corresponds to the JSON property `showCustomUi` - # @return [Boolean] - attr_accessor :show_custom_ui - alias_method :show_custom_ui?, :show_custom_ui - - # True if invalid data should be rejected. - # Corresponds to the JSON property `strict` - # @return [Boolean] - attr_accessor :strict - alias_method :strict?, :strict - - # A message to show the user when adding data to the cell. - # Corresponds to the JSON property `inputMessage` - # @return [String] - attr_accessor :input_message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @condition = args[:condition] if args.key?(:condition) - @show_custom_ui = args[:show_custom_ui] if args.key?(:show_custom_ui) - @strict = args[:strict] if args.key?(:strict) - @input_message = args[:input_message] if args.key?(:input_message) - end - end - - # The domain of a chart. - # For example, if charting stock prices over time, this would be the date. - class BasicChartDomain - include Google::Apis::Core::Hashable - - # The data included in a domain or series. - # Corresponds to the JSON property `domain` - # @return [Google::Apis::SheetsV4::ChartData] - attr_accessor :domain - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @domain = args[:domain] if args.key?(:domain) - end - end - - # Inserts data into the spreadsheet starting at the specified coordinate. - class PasteDataRequest - include Google::Apis::Core::Hashable - - # True if the data is HTML. - # Corresponds to the JSON property `html` - # @return [Boolean] - attr_accessor :html - alias_method :html?, :html - - # A coordinate in a sheet. - # All indexes are zero-based. - # Corresponds to the JSON property `coordinate` - # @return [Google::Apis::SheetsV4::GridCoordinate] - attr_accessor :coordinate - - # The data to insert. - # Corresponds to the JSON property `data` - # @return [String] - attr_accessor :data - - # The delimiter in the data. - # Corresponds to the JSON property `delimiter` - # @return [String] - attr_accessor :delimiter - - # How the data should be pasted. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @html = args[:html] if args.key?(:html) - @coordinate = args[:coordinate] if args.key?(:coordinate) - @data = args[:data] if args.key?(:data) - @delimiter = args[:delimiter] if args.key?(:delimiter) - @type = args[:type] if args.key?(:type) - end - end - - # Appends rows or columns to the end of a sheet. - class AppendDimensionRequest - include Google::Apis::Core::Hashable - - # The sheet to append rows or columns to. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # Whether rows or columns should be appended. - # Corresponds to the JSON property `dimension` - # @return [String] - attr_accessor :dimension - - # The number of rows or columns to append. - # Corresponds to the JSON property `length` - # @return [Fixnum] - attr_accessor :length - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - @dimension = args[:dimension] if args.key?(:dimension) - @length = args[:length] if args.key?(:length) - end - end - - # Adds a named range to the spreadsheet. - class AddNamedRangeRequest - include Google::Apis::Core::Hashable - - # A named range. - # Corresponds to the JSON property `namedRange` - # @return [Google::Apis::SheetsV4::NamedRange] - attr_accessor :named_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @named_range = args[:named_range] if args.key?(:named_range) - end - end - - # Update an embedded object's position (such as a moving or resizing a - # chart or image). - class UpdateEmbeddedObjectPositionRequest - include Google::Apis::Core::Hashable - - # The position of an embedded object such as a chart. - # Corresponds to the JSON property `newPosition` - # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] - attr_accessor :new_position - - # The fields of OverlayPosition - # that should be updated when setting a new position. Used only if - # newPosition.overlayPosition - # is set, in which case at least one field must - # be specified. The root `newPosition.overlayPosition` is implied and - # should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - # The ID of the object to moved. - # Corresponds to the JSON property `objectId` - # @return [Fixnum] - attr_accessor :object_id_prop - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_position = args[:new_position] if args.key?(:new_position) - @fields = args[:fields] if args.key?(:fields) - @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) - end - end - - # A pie chart. - class PieChartSpec - include Google::Apis::Core::Hashable - - # Where the legend of the pie chart should be drawn. - # Corresponds to the JSON property `legendPosition` - # @return [String] - attr_accessor :legend_position - - # The size of the hole in the pie chart. - # Corresponds to the JSON property `pieHole` - # @return [Float] - attr_accessor :pie_hole - - # The data included in a domain or series. - # Corresponds to the JSON property `domain` - # @return [Google::Apis::SheetsV4::ChartData] - attr_accessor :domain - - # True if the pie is three dimensional. - # Corresponds to the JSON property `threeDimensional` - # @return [Boolean] - attr_accessor :three_dimensional - alias_method :three_dimensional?, :three_dimensional - - # The data included in a domain or series. - # Corresponds to the JSON property `series` - # @return [Google::Apis::SheetsV4::ChartData] - attr_accessor :series - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @legend_position = args[:legend_position] if args.key?(:legend_position) - @pie_hole = args[:pie_hole] if args.key?(:pie_hole) - @domain = args[:domain] if args.key?(:domain) - @three_dimensional = args[:three_dimensional] if args.key?(:three_dimensional) - @series = args[:series] if args.key?(:series) - end - end - - # Updates properties of the filter view. - class UpdateFilterViewRequest - include Google::Apis::Core::Hashable - - # A filter view. - # Corresponds to the JSON property `filter` - # @return [Google::Apis::SheetsV4::FilterView] - attr_accessor :filter - - # The fields that should be updated. At least one field must be specified. - # The root `filter` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` - # @return [String] - attr_accessor :fields - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - @fields = args[:fields] if args.key?(:fields) - end - end - - # A rule describing a conditional format. - class ConditionalFormatRule - include Google::Apis::Core::Hashable - - # The ranges that will be formatted if the condition is true. - # All the ranges must be on the same grid. - # Corresponds to the JSON property `ranges` - # @return [Array] - attr_accessor :ranges - - # A rule that applies a gradient color scale format, based on - # the interpolation points listed. The format of a cell will vary - # based on its contents as compared to the values of the interpolation - # points. - # Corresponds to the JSON property `gradientRule` - # @return [Google::Apis::SheetsV4::GradientRule] - attr_accessor :gradient_rule - - # A rule that may or may not match, depending on the condition. - # Corresponds to the JSON property `booleanRule` - # @return [Google::Apis::SheetsV4::BooleanRule] - attr_accessor :boolean_rule - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @ranges = args[:ranges] if args.key?(:ranges) - @gradient_rule = args[:gradient_rule] if args.key?(:gradient_rule) - @boolean_rule = args[:boolean_rule] if args.key?(:boolean_rule) - end - end - - # Copies data from the source to the destination. - class CopyPasteRequest - include Google::Apis::Core::Hashable - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `source` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :source - - # What kind of data to paste. - # Corresponds to the JSON property `pasteType` - # @return [String] - attr_accessor :paste_type - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `destination` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :destination - - # How that data should be oriented when pasting. - # Corresponds to the JSON property `pasteOrientation` - # @return [String] - attr_accessor :paste_orientation - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @source = args[:source] if args.key?(:source) - @paste_type = args[:paste_type] if args.key?(:paste_type) - @destination = args[:destination] if args.key?(:destination) - @paste_orientation = args[:paste_orientation] if args.key?(:paste_orientation) - end - end - - # A single kind of update to apply to a spreadsheet. - class Request - include Google::Apis::Core::Hashable - - # Adds a new conditional format rule at the given index. - # All subsequent rules' indexes are incremented. - # Corresponds to the JSON property `addConditionalFormatRule` - # @return [Google::Apis::SheetsV4::AddConditionalFormatRuleRequest] - attr_accessor :add_conditional_format_rule - - # Adds a named range to the spreadsheet. - # Corresponds to the JSON property `addNamedRange` - # @return [Google::Apis::SheetsV4::AddNamedRangeRequest] - attr_accessor :add_named_range - - # Updates all cells in a range with new data. - # Corresponds to the JSON property `updateCells` - # @return [Google::Apis::SheetsV4::UpdateCellsRequest] - attr_accessor :update_cells - - # Updates properties of a spreadsheet. - # Corresponds to the JSON property `updateSpreadsheetProperties` - # @return [Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest] - attr_accessor :update_spreadsheet_properties - - # Deletes the embedded object with the given ID. - # Corresponds to the JSON property `deleteEmbeddedObject` - # @return [Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest] - attr_accessor :delete_embedded_object - - # Updates properties of the filter view. - # Corresponds to the JSON property `updateFilterView` - # @return [Google::Apis::SheetsV4::UpdateFilterViewRequest] - attr_accessor :update_filter_view - - # Adds a new banded range to the spreadsheet. - # Corresponds to the JSON property `addBanding` - # @return [Google::Apis::SheetsV4::AddBandingRequest] - attr_accessor :add_banding - - # Adds new cells after the last row with data in a sheet, - # inserting new rows into the sheet if necessary. - # Corresponds to the JSON property `appendCells` - # @return [Google::Apis::SheetsV4::AppendCellsRequest] - attr_accessor :append_cells - - # Automatically resizes one or more dimensions based on the contents - # of the cells in that dimension. - # Corresponds to the JSON property `autoResizeDimensions` - # @return [Google::Apis::SheetsV4::AutoResizeDimensionsRequest] - attr_accessor :auto_resize_dimensions - - # Moves data from the source to the destination. - # Corresponds to the JSON property `cutPaste` - # @return [Google::Apis::SheetsV4::CutPasteRequest] - attr_accessor :cut_paste - - # Merges all cells in the range. - # Corresponds to the JSON property `mergeCells` - # @return [Google::Apis::SheetsV4::MergeCellsRequest] - attr_accessor :merge_cells - - # Updates properties of the named range with the specified - # namedRangeId. - # Corresponds to the JSON property `updateNamedRange` - # @return [Google::Apis::SheetsV4::UpdateNamedRangeRequest] - attr_accessor :update_named_range - - # Updates properties of the sheet with the specified - # sheetId. - # Corresponds to the JSON property `updateSheetProperties` - # @return [Google::Apis::SheetsV4::UpdateSheetPropertiesRequest] - attr_accessor :update_sheet_properties - - # Deletes the dimensions from the sheet. - # Corresponds to the JSON property `deleteDimension` - # @return [Google::Apis::SheetsV4::DeleteDimensionRequest] - attr_accessor :delete_dimension - - # Fills in more data based on existing data. - # Corresponds to the JSON property `autoFill` - # @return [Google::Apis::SheetsV4::AutoFillRequest] - attr_accessor :auto_fill - - # Sorts data in rows based on a sort order per column. - # Corresponds to the JSON property `sortRange` - # @return [Google::Apis::SheetsV4::SortRangeRequest] - attr_accessor :sort_range - - # Deletes the protected range with the given ID. - # Corresponds to the JSON property `deleteProtectedRange` - # @return [Google::Apis::SheetsV4::DeleteProtectedRangeRequest] - attr_accessor :delete_protected_range - - # Duplicates a particular filter view. - # Corresponds to the JSON property `duplicateFilterView` - # @return [Google::Apis::SheetsV4::DuplicateFilterViewRequest] - attr_accessor :duplicate_filter_view - - # Adds a chart to a sheet in the spreadsheet. - # Corresponds to the JSON property `addChart` - # @return [Google::Apis::SheetsV4::AddChartRequest] - attr_accessor :add_chart - - # Finds and replaces data in cells over a range, sheet, or all sheets. - # Corresponds to the JSON property `findReplace` - # @return [Google::Apis::SheetsV4::FindReplaceRequest] - attr_accessor :find_replace - - # Splits a column of text into multiple columns, - # based on a delimiter in each cell. - # Corresponds to the JSON property `textToColumns` - # @return [Google::Apis::SheetsV4::TextToColumnsRequest] - attr_accessor :text_to_columns - - # Updates a chart's specifications. - # (This does not move or resize a chart. To move or resize a chart, use - # UpdateEmbeddedObjectPositionRequest.) - # Corresponds to the JSON property `updateChartSpec` - # @return [Google::Apis::SheetsV4::UpdateChartSpecRequest] - attr_accessor :update_chart_spec - - # Adds a new sheet. - # When a sheet is added at a given index, - # all subsequent sheets' indexes are incremented. - # To add an object sheet, use AddChartRequest instead and specify - # EmbeddedObjectPosition.sheetId or - # EmbeddedObjectPosition.newSheet. - # Corresponds to the JSON property `addSheet` - # @return [Google::Apis::SheetsV4::AddSheetRequest] - attr_accessor :add_sheet - - # Updates an existing protected range with the specified - # protectedRangeId. - # Corresponds to the JSON property `updateProtectedRange` - # @return [Google::Apis::SheetsV4::UpdateProtectedRangeRequest] - attr_accessor :update_protected_range - - # Deletes a particular filter view. - # Corresponds to the JSON property `deleteFilterView` - # @return [Google::Apis::SheetsV4::DeleteFilterViewRequest] - attr_accessor :delete_filter_view - - # Copies data from the source to the destination. - # Corresponds to the JSON property `copyPaste` - # @return [Google::Apis::SheetsV4::CopyPasteRequest] - attr_accessor :copy_paste - - # Inserts rows or columns in a sheet at a particular index. - # Corresponds to the JSON property `insertDimension` - # @return [Google::Apis::SheetsV4::InsertDimensionRequest] - attr_accessor :insert_dimension - - # Deletes a range of cells, shifting other cells into the deleted area. - # Corresponds to the JSON property `deleteRange` - # @return [Google::Apis::SheetsV4::DeleteRangeRequest] - attr_accessor :delete_range - - # Removes the banded range with the given ID from the spreadsheet. - # Corresponds to the JSON property `deleteBanding` - # @return [Google::Apis::SheetsV4::DeleteBandingRequest] - attr_accessor :delete_banding - - # Adds a filter view. - # Corresponds to the JSON property `addFilterView` - # @return [Google::Apis::SheetsV4::AddFilterViewRequest] - attr_accessor :add_filter_view - - # Sets a data validation rule to every cell in the range. - # To clear validation in a range, call this with no rule specified. - # Corresponds to the JSON property `setDataValidation` - # @return [Google::Apis::SheetsV4::SetDataValidationRequest] - attr_accessor :set_data_validation - - # Updates the borders of a range. - # If a field is not set in the request, that means the border remains as-is. - # For example, with two subsequent UpdateBordersRequest: - # 1. range: A1:A5 `` top: RED, bottom: WHITE `` - # 2. range: A1:A5 `` left: BLUE `` - # That would result in A1:A5 having a borders of - # `` top: RED, bottom: WHITE, left: BLUE ``. - # If you want to clear a border, explicitly set the style to - # NONE. - # Corresponds to the JSON property `updateBorders` - # @return [Google::Apis::SheetsV4::UpdateBordersRequest] - attr_accessor :update_borders - - # Deletes a conditional format rule at the given index. - # All subsequent rules' indexes are decremented. - # Corresponds to the JSON property `deleteConditionalFormatRule` - # @return [Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest] - attr_accessor :delete_conditional_format_rule - - # Updates all cells in the range to the values in the given Cell object. - # Only the fields listed in the fields field are updated; others are - # unchanged. - # If writing a cell with a formula, the formula's ranges will automatically - # increment for each field in the range. - # For example, if writing a cell with formula `=A1` into range B2:C4, - # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, - # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. - # To keep the formula's ranges static, use the `$` indicator. - # For example, use the formula `=$A$1` to prevent both the row and the - # column from incrementing. - # Corresponds to the JSON property `repeatCell` - # @return [Google::Apis::SheetsV4::RepeatCellRequest] - attr_accessor :repeat_cell - - # Clears the basic filter, if any exists on the sheet. - # Corresponds to the JSON property `clearBasicFilter` - # @return [Google::Apis::SheetsV4::ClearBasicFilterRequest] - attr_accessor :clear_basic_filter - - # Appends rows or columns to the end of a sheet. - # Corresponds to the JSON property `appendDimension` - # @return [Google::Apis::SheetsV4::AppendDimensionRequest] - attr_accessor :append_dimension - - # Updates a conditional format rule at the given index, - # or moves a conditional format rule to another index. - # Corresponds to the JSON property `updateConditionalFormatRule` - # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest] - attr_accessor :update_conditional_format_rule - - # Inserts cells into a range, shifting the existing cells over or down. - # Corresponds to the JSON property `insertRange` - # @return [Google::Apis::SheetsV4::InsertRangeRequest] - attr_accessor :insert_range - - # Moves one or more rows or columns. - # Corresponds to the JSON property `moveDimension` - # @return [Google::Apis::SheetsV4::MoveDimensionRequest] - attr_accessor :move_dimension - - # Updates properties of the supplied banded range. - # Corresponds to the JSON property `updateBanding` - # @return [Google::Apis::SheetsV4::UpdateBandingRequest] - attr_accessor :update_banding - - # Removes the named range with the given ID from the spreadsheet. - # Corresponds to the JSON property `deleteNamedRange` - # @return [Google::Apis::SheetsV4::DeleteNamedRangeRequest] - attr_accessor :delete_named_range - - # Adds a new protected range. - # Corresponds to the JSON property `addProtectedRange` - # @return [Google::Apis::SheetsV4::AddProtectedRangeRequest] - attr_accessor :add_protected_range - - # Duplicates the contents of a sheet. - # Corresponds to the JSON property `duplicateSheet` - # @return [Google::Apis::SheetsV4::DuplicateSheetRequest] - attr_accessor :duplicate_sheet - - # Deletes the requested sheet. - # Corresponds to the JSON property `deleteSheet` - # @return [Google::Apis::SheetsV4::DeleteSheetRequest] - attr_accessor :delete_sheet - - # Unmerges cells in the given range. - # Corresponds to the JSON property `unmergeCells` - # @return [Google::Apis::SheetsV4::UnmergeCellsRequest] - attr_accessor :unmerge_cells - - # Update an embedded object's position (such as a moving or resizing a - # chart or image). - # Corresponds to the JSON property `updateEmbeddedObjectPosition` - # @return [Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest] - attr_accessor :update_embedded_object_position - - # Updates properties of dimensions within the specified range. - # Corresponds to the JSON property `updateDimensionProperties` - # @return [Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest] - attr_accessor :update_dimension_properties - - # Inserts data into the spreadsheet starting at the specified coordinate. - # Corresponds to the JSON property `pasteData` - # @return [Google::Apis::SheetsV4::PasteDataRequest] - attr_accessor :paste_data - - # Sets the basic filter associated with a sheet. - # Corresponds to the JSON property `setBasicFilter` - # @return [Google::Apis::SheetsV4::SetBasicFilterRequest] - attr_accessor :set_basic_filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @add_conditional_format_rule = args[:add_conditional_format_rule] if args.key?(:add_conditional_format_rule) - @add_named_range = args[:add_named_range] if args.key?(:add_named_range) - @update_cells = args[:update_cells] if args.key?(:update_cells) - @update_spreadsheet_properties = args[:update_spreadsheet_properties] if args.key?(:update_spreadsheet_properties) - @delete_embedded_object = args[:delete_embedded_object] if args.key?(:delete_embedded_object) - @update_filter_view = args[:update_filter_view] if args.key?(:update_filter_view) - @add_banding = args[:add_banding] if args.key?(:add_banding) - @append_cells = args[:append_cells] if args.key?(:append_cells) - @auto_resize_dimensions = args[:auto_resize_dimensions] if args.key?(:auto_resize_dimensions) - @cut_paste = args[:cut_paste] if args.key?(:cut_paste) - @merge_cells = args[:merge_cells] if args.key?(:merge_cells) - @update_named_range = args[:update_named_range] if args.key?(:update_named_range) - @update_sheet_properties = args[:update_sheet_properties] if args.key?(:update_sheet_properties) - @delete_dimension = args[:delete_dimension] if args.key?(:delete_dimension) - @auto_fill = args[:auto_fill] if args.key?(:auto_fill) - @sort_range = args[:sort_range] if args.key?(:sort_range) - @delete_protected_range = args[:delete_protected_range] if args.key?(:delete_protected_range) - @duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view) - @add_chart = args[:add_chart] if args.key?(:add_chart) - @find_replace = args[:find_replace] if args.key?(:find_replace) - @text_to_columns = args[:text_to_columns] if args.key?(:text_to_columns) - @update_chart_spec = args[:update_chart_spec] if args.key?(:update_chart_spec) - @add_sheet = args[:add_sheet] if args.key?(:add_sheet) - @update_protected_range = args[:update_protected_range] if args.key?(:update_protected_range) - @delete_filter_view = args[:delete_filter_view] if args.key?(:delete_filter_view) - @copy_paste = args[:copy_paste] if args.key?(:copy_paste) - @insert_dimension = args[:insert_dimension] if args.key?(:insert_dimension) - @delete_range = args[:delete_range] if args.key?(:delete_range) - @delete_banding = args[:delete_banding] if args.key?(:delete_banding) - @add_filter_view = args[:add_filter_view] if args.key?(:add_filter_view) - @set_data_validation = args[:set_data_validation] if args.key?(:set_data_validation) - @update_borders = args[:update_borders] if args.key?(:update_borders) - @delete_conditional_format_rule = args[:delete_conditional_format_rule] if args.key?(:delete_conditional_format_rule) - @repeat_cell = args[:repeat_cell] if args.key?(:repeat_cell) - @clear_basic_filter = args[:clear_basic_filter] if args.key?(:clear_basic_filter) - @append_dimension = args[:append_dimension] if args.key?(:append_dimension) - @update_conditional_format_rule = args[:update_conditional_format_rule] if args.key?(:update_conditional_format_rule) - @insert_range = args[:insert_range] if args.key?(:insert_range) - @move_dimension = args[:move_dimension] if args.key?(:move_dimension) - @update_banding = args[:update_banding] if args.key?(:update_banding) - @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range) - @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range) - @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet) - @delete_sheet = args[:delete_sheet] if args.key?(:delete_sheet) - @unmerge_cells = args[:unmerge_cells] if args.key?(:unmerge_cells) - @update_embedded_object_position = args[:update_embedded_object_position] if args.key?(:update_embedded_object_position) - @update_dimension_properties = args[:update_dimension_properties] if args.key?(:update_dimension_properties) - @paste_data = args[:paste_data] if args.key?(:paste_data) - @set_basic_filter = args[:set_basic_filter] if args.key?(:set_basic_filter) - end - end - - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. - class BooleanCondition - include Google::Apis::Core::Hashable - - # The type of condition. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # The values of the condition. The number of supported values depends - # on the condition type. Some support zero values, - # others one or two values, - # and ConditionType.ONE_OF_LIST supports an arbitrary number of values. - # Corresponds to the JSON property `values` - # @return [Array] - attr_accessor :values - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @type = args[:type] if args.key?(:type) - @values = args[:values] if args.key?(:values) - end - end - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - class GridRange - include Google::Apis::Core::Hashable - - # The end row (exclusive) of the range, or not set if unbounded. - # Corresponds to the JSON property `endRowIndex` - # @return [Fixnum] - attr_accessor :end_row_index - - # The end column (exclusive) of the range, or not set if unbounded. - # Corresponds to the JSON property `endColumnIndex` - # @return [Fixnum] - attr_accessor :end_column_index - - # The start row (inclusive) of the range, or not set if unbounded. - # Corresponds to the JSON property `startRowIndex` - # @return [Fixnum] - attr_accessor :start_row_index - - # The start column (inclusive) of the range, or not set if unbounded. - # Corresponds to the JSON property `startColumnIndex` - # @return [Fixnum] - attr_accessor :start_column_index - - # The sheet this range is on. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_row_index = args[:end_row_index] if args.key?(:end_row_index) - @end_column_index = args[:end_column_index] if args.key?(:end_column_index) - @start_row_index = args[:start_row_index] if args.key?(:start_row_index) - @start_column_index = args[:start_column_index] if args.key?(:start_column_index) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - end - end - - # The specification for a basic chart. See BasicChartType for the list - # of charts this supports. - class BasicChartSpec - include Google::Apis::Core::Hashable - - # The domain of data this is charting. - # Only a single domain is currently supported. - # Corresponds to the JSON property `domains` - # @return [Array] - attr_accessor :domains - - # The number of rows or columns in the data that are "headers". - # If not set, Google Sheets will guess how many rows are headers based - # on the data. - # (Note that BasicChartAxis.title may override the axis title - # inferred from the header values.) - # Corresponds to the JSON property `headerCount` - # @return [Fixnum] - attr_accessor :header_count - - # The axis on the chart. - # Corresponds to the JSON property `axis` - # @return [Array] - attr_accessor :axis - - # The type of the chart. - # Corresponds to the JSON property `chartType` - # @return [String] - attr_accessor :chart_type - - # The data this chart is visualizing. - # Corresponds to the JSON property `series` - # @return [Array] - attr_accessor :series - - # The position of the chart legend. - # Corresponds to the JSON property `legendPosition` - # @return [String] - attr_accessor :legend_position - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @domains = args[:domains] if args.key?(:domains) - @header_count = args[:header_count] if args.key?(:header_count) - @axis = args[:axis] if args.key?(:axis) - @chart_type = args[:chart_type] if args.key?(:chart_type) - @series = args[:series] if args.key?(:series) - @legend_position = args[:legend_position] if args.key?(:legend_position) - end - end - - # Sets a data validation rule to every cell in the range. - # To clear validation in a range, call this with no rule specified. - class SetDataValidationRequest - include Google::Apis::Core::Hashable - - # A data validation rule. - # Corresponds to the JSON property `rule` - # @return [Google::Apis::SheetsV4::DataValidationRule] - attr_accessor :rule - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rule = args[:rule] if args.key?(:rule) - @range = args[:range] if args.key?(:range) - end - end - - # Data about a specific cell. - class CellData - include Google::Apis::Core::Hashable - - # The kinds of value that a cell in a spreadsheet can have. - # Corresponds to the JSON property `effectiveValue` - # @return [Google::Apis::SheetsV4::ExtendedValue] - attr_accessor :effective_value - - # Runs of rich text applied to subsections of the cell. Runs are only valid - # on user entered strings, not formulas, bools, or numbers. - # Runs start at specific indexes in the text and continue until the next - # run. Properties of a run will continue unless explicitly changed - # in a subsequent run (and properties of the first run will continue - # the properties of the cell unless explicitly changed). - # When writing, the new runs will overwrite any prior runs. When writing a - # new user_entered_value, previous runs will be erased. - # Corresponds to the JSON property `textFormatRuns` - # @return [Array] - attr_accessor :text_format_runs - - # The formatted value of the cell. - # This is the value as it's shown to the user. - # This field is read-only. - # Corresponds to the JSON property `formattedValue` - # @return [String] - attr_accessor :formatted_value - - # A hyperlink this cell points to, if any. - # This field is read-only. (To set it, use a `=HYPERLINK` formula.) - # Corresponds to the JSON property `hyperlink` - # @return [String] - attr_accessor :hyperlink - - # A pivot table. - # Corresponds to the JSON property `pivotTable` - # @return [Google::Apis::SheetsV4::PivotTable] - attr_accessor :pivot_table - - # The format of a cell. - # Corresponds to the JSON property `userEnteredFormat` - # @return [Google::Apis::SheetsV4::CellFormat] - attr_accessor :user_entered_format - - # The format of a cell. - # Corresponds to the JSON property `effectiveFormat` - # @return [Google::Apis::SheetsV4::CellFormat] - attr_accessor :effective_format - - # Any note on the cell. - # Corresponds to the JSON property `note` - # @return [String] - attr_accessor :note - - # The kinds of value that a cell in a spreadsheet can have. - # Corresponds to the JSON property `userEnteredValue` - # @return [Google::Apis::SheetsV4::ExtendedValue] - attr_accessor :user_entered_value - - # A data validation rule. - # Corresponds to the JSON property `dataValidation` - # @return [Google::Apis::SheetsV4::DataValidationRule] - attr_accessor :data_validation - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @effective_value = args[:effective_value] if args.key?(:effective_value) - @text_format_runs = args[:text_format_runs] if args.key?(:text_format_runs) - @formatted_value = args[:formatted_value] if args.key?(:formatted_value) - @hyperlink = args[:hyperlink] if args.key?(:hyperlink) - @pivot_table = args[:pivot_table] if args.key?(:pivot_table) - @user_entered_format = args[:user_entered_format] if args.key?(:user_entered_format) - @effective_format = args[:effective_format] if args.key?(:effective_format) - @note = args[:note] if args.key?(:note) - @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value) - @data_validation = args[:data_validation] if args.key?(:data_validation) - end - end - # The request for updating any aspect of a spreadsheet. class BatchUpdateSpreadsheetRequest include Google::Apis::Core::Hashable @@ -4790,6 +2735,11 @@ module Google attr_accessor :include_spreadsheet_in_response alias_method :include_spreadsheet_in_response?, :include_spreadsheet_in_response + # A list of updates to apply to the spreadsheet. + # Corresponds to the JSON property `requests` + # @return [Array] + attr_accessor :requests + # Limits the ranges included in the response spreadsheet. # Meaningful only if include_spreadsheet_response is 'true'. # Corresponds to the JSON property `responseRanges` @@ -4804,11 +2754,6 @@ module Google attr_accessor :response_include_grid_data alias_method :response_include_grid_data?, :response_include_grid_data - # A list of updates to apply to the spreadsheet. - # Corresponds to the JSON property `requests` - # @return [Array] - attr_accessor :requests - def initialize(**args) update!(**args) end @@ -4816,699 +2761,9 @@ module Google # Update properties of this object def update!(**args) @include_spreadsheet_in_response = args[:include_spreadsheet_in_response] if args.key?(:include_spreadsheet_in_response) + @requests = args[:requests] if args.key?(:requests) @response_ranges = args[:response_ranges] if args.key?(:response_ranges) @response_include_grid_data = args[:response_include_grid_data] if args.key?(:response_include_grid_data) - @requests = args[:requests] if args.key?(:requests) - end - end - - # An axis of the chart. - # A chart may not have more than one axis per - # axis position. - class BasicChartAxis - include Google::Apis::Core::Hashable - - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. - # Corresponds to the JSON property `format` - # @return [Google::Apis::SheetsV4::TextFormat] - attr_accessor :format - - # The position of this axis. - # Corresponds to the JSON property `position` - # @return [String] - attr_accessor :position - - # The title of this axis. If set, this overrides any title inferred - # from headers of the data. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @format = args[:format] if args.key?(:format) - @position = args[:position] if args.key?(:position) - @title = args[:title] if args.key?(:title) - end - end - - # The amount of padding around the cell, in pixels. - # When updating padding, every field must be specified. - class Padding - include Google::Apis::Core::Hashable - - # The bottom padding of the cell. - # Corresponds to the JSON property `bottom` - # @return [Fixnum] - attr_accessor :bottom - - # The top padding of the cell. - # Corresponds to the JSON property `top` - # @return [Fixnum] - attr_accessor :top - - # The left padding of the cell. - # Corresponds to the JSON property `left` - # @return [Fixnum] - attr_accessor :left - - # The right padding of the cell. - # Corresponds to the JSON property `right` - # @return [Fixnum] - attr_accessor :right - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bottom = args[:bottom] if args.key?(:bottom) - @top = args[:top] if args.key?(:top) - @left = args[:left] if args.key?(:left) - @right = args[:right] if args.key?(:right) - end - end - - # Deletes the dimensions from the sheet. - class DeleteDimensionRequest - include Google::Apis::Core::Hashable - - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::DimensionRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @range = args[:range] if args.key?(:range) - end - end - - # Updates a chart's specifications. - # (This does not move or resize a chart. To move or resize a chart, use - # UpdateEmbeddedObjectPositionRequest.) - class UpdateChartSpecRequest - include Google::Apis::Core::Hashable - - # The specifications of a chart. - # Corresponds to the JSON property `spec` - # @return [Google::Apis::SheetsV4::ChartSpec] - attr_accessor :spec - - # The ID of the chart to update. - # Corresponds to the JSON property `chartId` - # @return [Fixnum] - attr_accessor :chart_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @spec = args[:spec] if args.key?(:spec) - @chart_id = args[:chart_id] if args.key?(:chart_id) - end - end - - # Deletes a particular filter view. - class DeleteFilterViewRequest - include Google::Apis::Core::Hashable - - # The ID of the filter to delete. - # Corresponds to the JSON property `filterId` - # @return [Fixnum] - attr_accessor :filter_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter_id = args[:filter_id] if args.key?(:filter_id) - end - end - - # The response when updating a range of values in a spreadsheet. - class BatchUpdateValuesResponse - include Google::Apis::Core::Hashable - - # The total number of columns where at least one cell in the column was - # updated. - # Corresponds to the JSON property `totalUpdatedColumns` - # @return [Fixnum] - attr_accessor :total_updated_columns - - # The spreadsheet the updates were applied to. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - # The total number of rows where at least one cell in the row was updated. - # Corresponds to the JSON property `totalUpdatedRows` - # @return [Fixnum] - attr_accessor :total_updated_rows - - # One UpdateValuesResponse per requested range, in the same order as - # the requests appeared. - # Corresponds to the JSON property `responses` - # @return [Array] - attr_accessor :responses - - # The total number of sheets where at least one cell in the sheet was - # updated. - # Corresponds to the JSON property `totalUpdatedSheets` - # @return [Fixnum] - attr_accessor :total_updated_sheets - - # The total number of cells updated. - # Corresponds to the JSON property `totalUpdatedCells` - # @return [Fixnum] - attr_accessor :total_updated_cells - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @total_updated_columns = args[:total_updated_columns] if args.key?(:total_updated_columns) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - @total_updated_rows = args[:total_updated_rows] if args.key?(:total_updated_rows) - @responses = args[:responses] if args.key?(:responses) - @total_updated_sheets = args[:total_updated_sheets] if args.key?(:total_updated_sheets) - @total_updated_cells = args[:total_updated_cells] if args.key?(:total_updated_cells) - end - end - - # Sorts data in rows based on a sort order per column. - class SortRangeRequest - include Google::Apis::Core::Hashable - - # The sort order per column. Later specifications are used when values - # are equal in the earlier specifications. - # Corresponds to the JSON property `sortSpecs` - # @return [Array] - attr_accessor :sort_specs - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sort_specs = args[:sort_specs] if args.key?(:sort_specs) - @range = args[:range] if args.key?(:range) - end - end - - # Merges all cells in the range. - class MergeCellsRequest - include Google::Apis::Core::Hashable - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :range - - # How the cells should be merged. - # Corresponds to the JSON property `mergeType` - # @return [String] - attr_accessor :merge_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @range = args[:range] if args.key?(:range) - @merge_type = args[:merge_type] if args.key?(:merge_type) - end - end - - # Adds a new protected range. - class AddProtectedRangeRequest - include Google::Apis::Core::Hashable - - # A protected range. - # Corresponds to the JSON property `protectedRange` - # @return [Google::Apis::SheetsV4::ProtectedRange] - attr_accessor :protected_range - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @protected_range = args[:protected_range] if args.key?(:protected_range) - end - end - - # The request for clearing more than one range of values in a spreadsheet. - class BatchClearValuesRequest - include Google::Apis::Core::Hashable - - # The ranges to clear, in A1 notation. - # Corresponds to the JSON property `ranges` - # @return [Array] - attr_accessor :ranges - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @ranges = args[:ranges] if args.key?(:ranges) - end - end - - # The result of a filter view being duplicated. - class DuplicateFilterViewResponse - include Google::Apis::Core::Hashable - - # A filter view. - # Corresponds to the JSON property `filter` - # @return [Google::Apis::SheetsV4::FilterView] - attr_accessor :filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - end - end - - # The result of duplicating a sheet. - class DuplicateSheetResponse - include Google::Apis::Core::Hashable - - # Properties of a sheet. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::SheetProperties] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @properties = args[:properties] if args.key?(:properties) - end - end - - # Splits a column of text into multiple columns, - # based on a delimiter in each cell. - class TextToColumnsRequest - include Google::Apis::Core::Hashable - - # The delimiter to use. Used only if delimiterType is - # CUSTOM. - # Corresponds to the JSON property `delimiter` - # @return [String] - attr_accessor :delimiter - - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, e.g the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. - # Corresponds to the JSON property `source` - # @return [Google::Apis::SheetsV4::GridRange] - attr_accessor :source - - # The delimiter type to use. - # Corresponds to the JSON property `delimiterType` - # @return [String] - attr_accessor :delimiter_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @delimiter = args[:delimiter] if args.key?(:delimiter) - @source = args[:source] if args.key?(:source) - @delimiter_type = args[:delimiter_type] if args.key?(:delimiter_type) - end - end - - # Clears the basic filter, if any exists on the sheet. - class ClearBasicFilterRequest - include Google::Apis::Core::Hashable - - # The sheet ID on which the basic filter should be cleared. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sheet_id = args[:sheet_id] if args.key?(:sheet_id) - end - end - - # The reply for batch updating a spreadsheet. - class BatchUpdateSpreadsheetResponse - include Google::Apis::Core::Hashable - - # The reply of the updates. This maps 1:1 with the updates, although - # replies to some requests may be empty. - # Corresponds to the JSON property `replies` - # @return [Array] - attr_accessor :replies - - # Resource that represents a spreadsheet. - # Corresponds to the JSON property `updatedSpreadsheet` - # @return [Google::Apis::SheetsV4::Spreadsheet] - attr_accessor :updated_spreadsheet - - # The spreadsheet the updates were applied to. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @replies = args[:replies] if args.key?(:replies) - @updated_spreadsheet = args[:updated_spreadsheet] if args.key?(:updated_spreadsheet) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - end - end - - # Removes the banded range with the given ID from the spreadsheet. - class DeleteBandingRequest - include Google::Apis::Core::Hashable - - # The ID of the banded range to delete. - # Corresponds to the JSON property `bandedRangeId` - # @return [Fixnum] - attr_accessor :banded_range_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @banded_range_id = args[:banded_range_id] if args.key?(:banded_range_id) - end - end - - # The response when updating a range of values in a spreadsheet. - class AppendValuesResponse - include Google::Apis::Core::Hashable - - # The response when updating a range of values in a spreadsheet. - # Corresponds to the JSON property `updates` - # @return [Google::Apis::SheetsV4::UpdateValuesResponse] - attr_accessor :updates - - # The range (in A1 notation) of the table that values are being appended to - # (before the values were appended). - # Empty if no table was found. - # Corresponds to the JSON property `tableRange` - # @return [String] - attr_accessor :table_range - - # The spreadsheet the updates were applied to. - # Corresponds to the JSON property `spreadsheetId` - # @return [String] - attr_accessor :spreadsheet_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @updates = args[:updates] if args.key?(:updates) - @table_range = args[:table_range] if args.key?(:table_range) - @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) - end - end - - # Moves one or more rows or columns. - class MoveDimensionRequest - include Google::Apis::Core::Hashable - - # The zero-based start index of where to move the source data to, - # based on the coordinates *before* the source data is removed - # from the grid. Existing data will be shifted down or right - # (depending on the dimension) to make room for the moved dimensions. - # The source dimensions are removed from the grid, so the - # the data may end up in a different index than specified. - # For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move - # `"1"` and `"2"` to between `"3"` and `"4"`, the source would be - # `ROWS [1..3)`,and the destination index would be `"4"` - # (the zero-based index of row 5). - # The end result would be `A1..A5` of `0, 3, 1, 2, 4`. - # Corresponds to the JSON property `destinationIndex` - # @return [Fixnum] - attr_accessor :destination_index - - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. - # Corresponds to the JSON property `source` - # @return [Google::Apis::SheetsV4::DimensionRange] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @destination_index = args[:destination_index] if args.key?(:destination_index) - @source = args[:source] if args.key?(:source) - end - end - - # Criteria for showing/hiding rows in a pivot table. - class PivotFilterCriteria - include Google::Apis::Core::Hashable - - # Values that should be included. Values not listed here are excluded. - # Corresponds to the JSON property `visibleValues` - # @return [Array] - attr_accessor :visible_values - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @visible_values = args[:visible_values] if args.key?(:visible_values) - end - end - - # Adds a filter view. - class AddFilterViewRequest - include Google::Apis::Core::Hashable - - # A filter view. - # Corresponds to the JSON property `filter` - # @return [Google::Apis::SheetsV4::FilterView] - attr_accessor :filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - end - end - - # Adds a new conditional format rule at the given index. - # All subsequent rules' indexes are incremented. - class AddConditionalFormatRuleRequest - include Google::Apis::Core::Hashable - - # A rule describing a conditional format. - # Corresponds to the JSON property `rule` - # @return [Google::Apis::SheetsV4::ConditionalFormatRule] - attr_accessor :rule - - # The zero-based index where the rule should be inserted. - # Corresponds to the JSON property `index` - # @return [Fixnum] - attr_accessor :index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rule = args[:rule] if args.key?(:rule) - @index = args[:index] if args.key?(:index) - end - end - - # The specifications of a chart. - class ChartSpec - include Google::Apis::Core::Hashable - - # A pie chart. - # Corresponds to the JSON property `pieChart` - # @return [Google::Apis::SheetsV4::PieChartSpec] - attr_accessor :pie_chart - - # The specification for a basic chart. See BasicChartType for the list - # of charts this supports. - # Corresponds to the JSON property `basicChart` - # @return [Google::Apis::SheetsV4::BasicChartSpec] - attr_accessor :basic_chart - - # Determines how the charts will use hidden rows or columns. - # Corresponds to the JSON property `hiddenDimensionStrategy` - # @return [String] - attr_accessor :hidden_dimension_strategy - - # The title of the chart. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pie_chart = args[:pie_chart] if args.key?(:pie_chart) - @basic_chart = args[:basic_chart] if args.key?(:basic_chart) - @hidden_dimension_strategy = args[:hidden_dimension_strategy] if args.key?(:hidden_dimension_strategy) - @title = args[:title] if args.key?(:title) - end - end - - # The number format of a cell. - class NumberFormat - include Google::Apis::Core::Hashable - - # Pattern string used for formatting. If not set, a default pattern based on - # the user's locale will be used if necessary for the given type. - # See the [Date and Number Formats guide](/sheets/guides/formats) for more - # information about the supported patterns. - # Corresponds to the JSON property `pattern` - # @return [String] - attr_accessor :pattern - - # The type of the number format. - # When writing, this field must be set. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pattern = args[:pattern] if args.key?(:pattern) - @type = args[:type] if args.key?(:type) end end @@ -5521,6 +2776,43 @@ module Google # @return [String] attr_accessor :title + # The index of the sheet within the spreadsheet. + # When adding or updating sheet properties, if this field + # is excluded then the sheet will be added or moved to the end + # of the sheet list. When updating sheet indices or inserting + # sheets, movement is considered in "before the move" indexes. + # For example, if there were 3 sheets (S1, S2, S3) in order to + # move S1 ahead of S2 the index would have to be set to 2. A sheet + # index update request will be ignored if the requested index is + # identical to the sheets current index or if the requested new + # index is equal to the current sheet index + 1. + # Corresponds to the JSON property `index` + # @return [Fixnum] + attr_accessor :index + + # True if the sheet is hidden in the UI, false if it's visible. + # Corresponds to the JSON property `hidden` + # @return [Boolean] + attr_accessor :hidden + alias_method :hidden?, :hidden + + # Properties of a grid. + # Corresponds to the JSON property `gridProperties` + # @return [Google::Apis::SheetsV4::GridProperties] + attr_accessor :grid_properties + + # The ID of the sheet. Must be non-negative. + # This field cannot be changed once set. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # True if the sheet is an RTL sheet instead of an LTR sheet. + # Corresponds to the JSON property `rightToLeft` + # @return [Boolean] + attr_accessor :right_to_left + alias_method :right_to_left?, :right_to_left + # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various # languages over compactness; for example, the fields of this representation @@ -5624,49 +2916,12 @@ module Google # @return [Google::Apis::SheetsV4::Color] attr_accessor :tab_color - # The index of the sheet within the spreadsheet. - # When adding or updating sheet properties, if this field - # is excluded then the sheet will be added or moved to the end - # of the sheet list. When updating sheet indices or inserting - # sheets, movement is considered in "before the move" indexes. - # For example, if there were 3 sheets (S1, S2, S3) in order to - # move S1 ahead of S2 the index would have to be set to 2. A sheet - # index update request will be ignored if the requested index is - # identical to the sheets current index or if the requested new - # index is equal to the current sheet index + 1. - # Corresponds to the JSON property `index` - # @return [Fixnum] - attr_accessor :index - - # The ID of the sheet. Must be non-negative. - # This field cannot be changed once set. - # Corresponds to the JSON property `sheetId` - # @return [Fixnum] - attr_accessor :sheet_id - - # True if the sheet is an RTL sheet instead of an LTR sheet. - # Corresponds to the JSON property `rightToLeft` - # @return [Boolean] - attr_accessor :right_to_left - alias_method :right_to_left?, :right_to_left - - # True if the sheet is hidden in the UI, false if it's visible. - # Corresponds to the JSON property `hidden` - # @return [Boolean] - attr_accessor :hidden - alias_method :hidden?, :hidden - # The type of sheet. Defaults to GRID. # This field cannot be changed once set. # Corresponds to the JSON property `sheetType` # @return [String] attr_accessor :sheet_type - # Properties of a grid. - # Corresponds to the JSON property `gridProperties` - # @return [Google::Apis::SheetsV4::GridProperties] - attr_accessor :grid_properties - def initialize(**args) update!(**args) end @@ -5674,39 +2929,107 @@ module Google # Update properties of this object def update!(**args) @title = args[:title] if args.key?(:title) - @tab_color = args[:tab_color] if args.key?(:tab_color) @index = args[:index] if args.key?(:index) + @hidden = args[:hidden] if args.key?(:hidden) + @grid_properties = args[:grid_properties] if args.key?(:grid_properties) @sheet_id = args[:sheet_id] if args.key?(:sheet_id) @right_to_left = args[:right_to_left] if args.key?(:right_to_left) - @hidden = args[:hidden] if args.key?(:hidden) + @tab_color = args[:tab_color] if args.key?(:tab_color) @sheet_type = args[:sheet_type] if args.key?(:sheet_type) - @grid_properties = args[:grid_properties] if args.key?(:grid_properties) end end - # Updates properties of dimensions within the specified range. - class UpdateDimensionPropertiesRequest + # The request for clearing a range of values in a spreadsheet. + class ClearValuesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `properties` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. - # Corresponds to the JSON property `fields` + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A protected range. + class ProtectedRange + include Google::Apis::Core::Hashable + + # The list of unprotected ranges within a protected sheet. + # Unprotected ranges are only supported on protected sheets. + # Corresponds to the JSON property `unprotectedRanges` + # @return [Array] + attr_accessor :unprotected_ranges + + # The description of this protected range. + # Corresponds to the JSON property `description` # @return [String] - attr_accessor :fields + attr_accessor :description - # Properties about a dimension. - # Corresponds to the JSON property `properties` - # @return [Google::Apis::SheetsV4::DimensionProperties] - attr_accessor :properties + # The named range this protected range is backed by, if any. + # When writing, only one of range or named_range_id + # may be set. + # Corresponds to the JSON property `namedRangeId` + # @return [String] + attr_accessor :named_range_id - # A range along a single dimension on a sheet. + # True if the user who requested this protected range can edit the + # protected area. + # This field is read-only. + # Corresponds to the JSON property `requestingUserCanEdit` + # @return [Boolean] + attr_accessor :requesting_user_can_edit + alias_method :requesting_user_can_edit?, :requesting_user_can_edit + + # The editors of a protected range. + # Corresponds to the JSON property `editors` + # @return [Google::Apis::SheetsV4::Editors] + attr_accessor :editors + + # The ID of the protected range. + # This field is read-only. + # Corresponds to the JSON property `protectedRangeId` + # @return [Fixnum] + attr_accessor :protected_range_id + + # True if this protected range will show a warning when editing. + # Warning-based protection means that every user can edit data in the + # protected range, except editing will prompt a warning asking the user + # to confirm the edit. + # When writing: if this field is true, then editors is ignored. + # Additionally, if this field is changed from true to false and the + # `editors` field is not set (nor included in the field mask), then + # the editors will be set to all the editors in the document. + # Corresponds to the JSON property `warningOnly` + # @return [Boolean] + attr_accessor :warning_only + alias_method :warning_only?, :warning_only + + # A range on a sheet. # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. # Corresponds to the JSON property `range` - # @return [Google::Apis::SheetsV4::DimensionRange] + # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range def initialize(**args) @@ -5715,24 +3038,182 @@ module Google # Update properties of this object def update!(**args) - @fields = args[:fields] if args.key?(:fields) - @properties = args[:properties] if args.key?(:properties) + @unprotected_ranges = args[:unprotected_ranges] if args.key?(:unprotected_ranges) + @description = args[:description] if args.key?(:description) + @named_range_id = args[:named_range_id] if args.key?(:named_range_id) + @requesting_user_can_edit = args[:requesting_user_can_edit] if args.key?(:requesting_user_can_edit) + @editors = args[:editors] if args.key?(:editors) + @protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id) + @warning_only = args[:warning_only] if args.key?(:warning_only) @range = args[:range] if args.key?(:range) end end + # Deletes a conditional format rule at the given index. + # All subsequent rules' indexes are decremented. + class DeleteConditionalFormatRuleRequest + include Google::Apis::Core::Hashable + + # The sheet the rule is being deleted from. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The zero-based index of the rule to be deleted. + # Corresponds to the JSON property `index` + # @return [Fixnum] + attr_accessor :index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @index = args[:index] if args.key?(:index) + end + end + + # Deletes a range of cells, shifting other cells into the deleted area. + class DeleteRangeRequest + include Google::Apis::Core::Hashable + + # The dimension from which deleted cells will be replaced with. + # If ROWS, existing cells will be shifted upward to + # replace the deleted cells. If COLUMNS, existing cells + # will be shifted left to replace the deleted cells. + # Corresponds to the JSON property `shiftDimension` + # @return [String] + attr_accessor :shift_dimension + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @shift_dimension = args[:shift_dimension] if args.key?(:shift_dimension) + @range = args[:range] if args.key?(:range) + end + end + + # Inserts cells into a range, shifting the existing cells over or down. + class InsertRangeRequest + include Google::Apis::Core::Hashable + + # The dimension which will be shifted when inserting cells. + # If ROWS, existing cells will be shifted down. + # If COLUMNS, existing cells will be shifted right. + # Corresponds to the JSON property `shiftDimension` + # @return [String] + attr_accessor :shift_dimension + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @shift_dimension = args[:shift_dimension] if args.key?(:shift_dimension) + @range = args[:range] if args.key?(:range) + end + end + + # The specifications of a chart. + class ChartSpec + include Google::Apis::Core::Hashable + + # Determines how the charts will use hidden rows or columns. + # Corresponds to the JSON property `hiddenDimensionStrategy` + # @return [String] + attr_accessor :hidden_dimension_strategy + + # The specification for a basic chart. See BasicChartType for the list + # of charts this supports. + # Corresponds to the JSON property `basicChart` + # @return [Google::Apis::SheetsV4::BasicChartSpec] + attr_accessor :basic_chart + + # The title of the chart. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # A pie chart. + # Corresponds to the JSON property `pieChart` + # @return [Google::Apis::SheetsV4::PieChartSpec] + attr_accessor :pie_chart + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hidden_dimension_strategy = args[:hidden_dimension_strategy] if args.key?(:hidden_dimension_strategy) + @basic_chart = args[:basic_chart] if args.key?(:basic_chart) + @title = args[:title] if args.key?(:title) + @pie_chart = args[:pie_chart] if args.key?(:pie_chart) + end + end + # A combination of a source range and how to extend that source. class SourceAndDestination include Google::Apis::Core::Hashable - # The number of rows or columns that data should be filled into. - # Positive numbers expand beyond the last row or last column - # of the source. Negative numbers expand before the first row - # or first column of the source. - # Corresponds to the JSON property `fillLength` - # @return [Fixnum] - attr_accessor :fill_length - # A range on a sheet. # All indexes are zero-based. # Indexes are half open, e.g the start index is inclusive @@ -5759,6 +3240,14 @@ module Google # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source + # The number of rows or columns that data should be filled into. + # Positive numbers expand beyond the last row or last column + # of the source. Negative numbers expand before the first row + # or first column of the source. + # Corresponds to the JSON property `fillLength` + # @return [Fixnum] + attr_accessor :fill_length + # The dimension that data should be filled into. # Corresponds to the JSON property `dimension` # @return [String] @@ -5770,14 +3259,516 @@ module Google # Update properties of this object def update!(**args) - @fill_length = args[:fill_length] if args.key?(:fill_length) @source = args[:source] if args.key?(:source) + @fill_length = args[:fill_length] if args.key?(:fill_length) @dimension = args[:dimension] if args.key?(:dimension) end end - # A filter view. - class FilterView + # The value of the condition. + class ConditionValue + include Google::Apis::Core::Hashable + + # A relative date (based on the current date). + # Valid only if the type is + # DATE_BEFORE, + # DATE_AFTER, + # DATE_ON_OR_BEFORE or + # DATE_ON_OR_AFTER. + # Relative dates are not supported in data validation. + # They are supported only in conditional formatting and + # conditional filters. + # Corresponds to the JSON property `relativeDate` + # @return [String] + attr_accessor :relative_date + + # A value the condition is based on. + # The value will be parsed as if the user typed into a cell. + # Formulas are supported (and must begin with an `=`). + # Corresponds to the JSON property `userEnteredValue` + # @return [String] + attr_accessor :user_entered_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @relative_date = args[:relative_date] if args.key?(:relative_date) + @user_entered_value = args[:user_entered_value] if args.key?(:user_entered_value) + end + end + + # Inserts data into the spreadsheet starting at the specified coordinate. + class PasteDataRequest + include Google::Apis::Core::Hashable + + # The data to insert. + # Corresponds to the JSON property `data` + # @return [String] + attr_accessor :data + + # A coordinate in a sheet. + # All indexes are zero-based. + # Corresponds to the JSON property `coordinate` + # @return [Google::Apis::SheetsV4::GridCoordinate] + attr_accessor :coordinate + + # The delimiter in the data. + # Corresponds to the JSON property `delimiter` + # @return [String] + attr_accessor :delimiter + + # How the data should be pasted. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # True if the data is HTML. + # Corresponds to the JSON property `html` + # @return [Boolean] + attr_accessor :html + alias_method :html?, :html + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data = args[:data] if args.key?(:data) + @coordinate = args[:coordinate] if args.key?(:coordinate) + @delimiter = args[:delimiter] if args.key?(:delimiter) + @type = args[:type] if args.key?(:type) + @html = args[:html] if args.key?(:html) + end + end + + # Finds and replaces data in cells over a range, sheet, or all sheets. + class FindReplaceRequest + include Google::Apis::Core::Hashable + + # The value to search. + # Corresponds to the JSON property `find` + # @return [String] + attr_accessor :find + + # The value to use as the replacement. + # Corresponds to the JSON property `replacement` + # @return [String] + attr_accessor :replacement + + # True if the find value is a regex. + # The regular expression and replacement should follow Java regex rules + # at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. + # The replacement string is allowed to refer to capturing groups. + # For example, if one cell has the contents `"Google Sheets"` and another + # has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of + # `"$1 Rocks"` would change the contents of the cells to + # `"GSheets Rocks"` and `"GDocs Rocks"` respectively. + # Corresponds to the JSON property `searchByRegex` + # @return [Boolean] + attr_accessor :search_by_regex + alias_method :search_by_regex?, :search_by_regex + + # The sheet to find/replace over. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # True to find/replace over all sheets. + # Corresponds to the JSON property `allSheets` + # @return [Boolean] + attr_accessor :all_sheets + alias_method :all_sheets?, :all_sheets + + # True if the search is case sensitive. + # Corresponds to the JSON property `matchCase` + # @return [Boolean] + attr_accessor :match_case + alias_method :match_case?, :match_case + + # True if the search should include cells with formulas. + # False to skip cells with formulas. + # Corresponds to the JSON property `includeFormulas` + # @return [Boolean] + attr_accessor :include_formulas + alias_method :include_formulas?, :include_formulas + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # True if the find value should match the entire cell. + # Corresponds to the JSON property `matchEntireCell` + # @return [Boolean] + attr_accessor :match_entire_cell + alias_method :match_entire_cell?, :match_entire_cell + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @find = args[:find] if args.key?(:find) + @replacement = args[:replacement] if args.key?(:replacement) + @search_by_regex = args[:search_by_regex] if args.key?(:search_by_regex) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @all_sheets = args[:all_sheets] if args.key?(:all_sheets) + @match_case = args[:match_case] if args.key?(:match_case) + @include_formulas = args[:include_formulas] if args.key?(:include_formulas) + @range = args[:range] if args.key?(:range) + @match_entire_cell = args[:match_entire_cell] if args.key?(:match_entire_cell) + end + end + + # A sort order associated with a specific column or row. + class SortSpec + include Google::Apis::Core::Hashable + + # The order data should be sorted. + # Corresponds to the JSON property `sortOrder` + # @return [String] + attr_accessor :sort_order + + # The dimension the sort should be applied to. + # Corresponds to the JSON property `dimensionIndex` + # @return [Fixnum] + attr_accessor :dimension_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sort_order = args[:sort_order] if args.key?(:sort_order) + @dimension_index = args[:dimension_index] if args.key?(:dimension_index) + end + end + + # The request to copy a sheet across spreadsheets. + class CopySheetToAnotherSpreadsheetRequest + include Google::Apis::Core::Hashable + + # The ID of the spreadsheet to copy the sheet to. + # Corresponds to the JSON property `destinationSpreadsheetId` + # @return [String] + attr_accessor :destination_spreadsheet_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_spreadsheet_id = args[:destination_spreadsheet_id] if args.key?(:destination_spreadsheet_id) + end + end + + # The number format of a cell. + class NumberFormat + include Google::Apis::Core::Hashable + + # Pattern string used for formatting. If not set, a default pattern based on + # the user's locale will be used if necessary for the given type. + # See the [Date and Number Formats guide](/sheets/guides/formats) for more + # information about the supported patterns. + # Corresponds to the JSON property `pattern` + # @return [String] + attr_accessor :pattern + + # The type of the number format. + # When writing, this field must be set. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pattern = args[:pattern] if args.key?(:pattern) + @type = args[:type] if args.key?(:type) + end + end + + # The request for clearing more than one range of values in a spreadsheet. + class BatchClearValuesRequest + include Google::Apis::Core::Hashable + + # The ranges to clear, in A1 notation. + # Corresponds to the JSON property `ranges` + # @return [Array] + attr_accessor :ranges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ranges = args[:ranges] if args.key?(:ranges) + end + end + + # Updates properties of dimensions within the specified range. + class UpdateDimensionPropertiesRequest + include Google::Apis::Core::Hashable + + # The fields that should be updated. At least one field must be specified. + # The root `properties` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::DimensionRange] + attr_accessor :range + + # Properties about a dimension. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::DimensionProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @range = args[:range] if args.key?(:range) + @properties = args[:properties] if args.key?(:properties) + end + end + + # The editors of a protected range. + class Editors + include Google::Apis::Core::Hashable + + # The email addresses of users with edit access to the protected range. + # Corresponds to the JSON property `users` + # @return [Array] + attr_accessor :users + + # The email addresses of groups with edit access to the protected range. + # Corresponds to the JSON property `groups` + # @return [Array] + attr_accessor :groups + + # True if anyone in the document's domain has edit access to the protected + # range. Domain protection is only supported on documents within a domain. + # Corresponds to the JSON property `domainUsersCanEdit` + # @return [Boolean] + attr_accessor :domain_users_can_edit + alias_method :domain_users_can_edit?, :domain_users_can_edit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @users = args[:users] if args.key?(:users) + @groups = args[:groups] if args.key?(:groups) + @domain_users_can_edit = args[:domain_users_can_edit] if args.key?(:domain_users_can_edit) + end + end + + # Resource that represents a spreadsheet. + class Spreadsheet + include Google::Apis::Core::Hashable + + # The ID of the spreadsheet. + # This field is read-only. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + # Properties of a spreadsheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SpreadsheetProperties] + attr_accessor :properties + + # The url of the spreadsheet. + # This field is read-only. + # Corresponds to the JSON property `spreadsheetUrl` + # @return [String] + attr_accessor :spreadsheet_url + + # The sheets that are part of a spreadsheet. + # Corresponds to the JSON property `sheets` + # @return [Array] + attr_accessor :sheets + + # The named ranges defined in a spreadsheet. + # Corresponds to the JSON property `namedRanges` + # @return [Array] + attr_accessor :named_ranges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @properties = args[:properties] if args.key?(:properties) + @spreadsheet_url = args[:spreadsheet_url] if args.key?(:spreadsheet_url) + @sheets = args[:sheets] if args.key?(:sheets) + @named_ranges = args[:named_ranges] if args.key?(:named_ranges) + end + end + + # Data in the grid, as well as metadata about the dimensions. + class GridData + include Google::Apis::Core::Hashable + + # Metadata about the requested columns in the grid, starting with the column + # in start_column. + # Corresponds to the JSON property `columnMetadata` + # @return [Array] + attr_accessor :column_metadata + + # The data in the grid, one entry per row, + # starting with the row in startRow. + # The values in RowData will correspond to columns starting + # at start_column. + # Corresponds to the JSON property `rowData` + # @return [Array] + attr_accessor :row_data + + # The first row this GridData refers to, zero-based. + # Corresponds to the JSON property `startRow` + # @return [Fixnum] + attr_accessor :start_row + + # Metadata about the requested rows in the grid, starting with the row + # in start_row. + # Corresponds to the JSON property `rowMetadata` + # @return [Array] + attr_accessor :row_metadata + + # The first column this GridData refers to, zero-based. + # Corresponds to the JSON property `startColumn` + # @return [Fixnum] + attr_accessor :start_column + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @column_metadata = args[:column_metadata] if args.key?(:column_metadata) + @row_data = args[:row_data] if args.key?(:row_data) + @start_row = args[:start_row] if args.key?(:start_row) + @row_metadata = args[:row_metadata] if args.key?(:row_metadata) + @start_column = args[:start_column] if args.key?(:start_column) + end + end + + # The definition of how a value in a pivot table should be calculated. + class PivotValue + include Google::Apis::Core::Hashable + + # A custom formula to calculate the value. The formula must start + # with an `=` character. + # Corresponds to the JSON property `formula` + # @return [String] + attr_accessor :formula + + # The column offset of the source range that this value reads from. + # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` + # means this value refers to column `C`, whereas the offset `1` would + # refer to column `D`. + # Corresponds to the JSON property `sourceColumnOffset` + # @return [Fixnum] + attr_accessor :source_column_offset + + # A function to summarize the value. + # If formula is set, the only supported values are + # SUM and + # CUSTOM. + # If sourceColumnOffset is set, then `CUSTOM` + # is not supported. + # Corresponds to the JSON property `summarizeFunction` + # @return [String] + attr_accessor :summarize_function + + # A name to use for the value. This is only used if formula was set. + # Otherwise, the column name is used. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @formula = args[:formula] if args.key?(:formula) + @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset) + @summarize_function = args[:summarize_function] if args.key?(:summarize_function) + @name = args[:name] if args.key?(:name) + end + end + + # Removes the banded range with the given ID from the spreadsheet. + class DeleteBandingRequest + include Google::Apis::Core::Hashable + + # The ID of the banded range to delete. + # Corresponds to the JSON property `bandedRangeId` + # @return [Fixnum] + attr_accessor :banded_range_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @banded_range_id = args[:banded_range_id] if args.key?(:banded_range_id) + end + end + + # The default filter associated with a sheet. + class BasicFilter include Google::Apis::Core::Hashable # The criteria for showing/hiding values per column. @@ -5787,11 +3778,6 @@ module Google # @return [Hash] attr_accessor :criteria - # The name of the filter view. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - # A range on a sheet. # All indexes are zero-based. # Indexes are half open, e.g the start index is inclusive @@ -5824,18 +3810,6 @@ module Google # @return [Array] attr_accessor :sort_specs - # The named range this filter view is backed by, if any. - # When writing, only one of range or named_range_id - # may be set. - # Corresponds to the JSON property `namedRangeId` - # @return [String] - attr_accessor :named_range_id - - # The ID of the filter view. - # Corresponds to the JSON property `filterViewId` - # @return [Fixnum] - attr_accessor :filter_view_id - def initialize(**args) update!(**args) end @@ -5843,28 +3817,104 @@ module Google # Update properties of this object def update!(**args) @criteria = args[:criteria] if args.key?(:criteria) - @title = args[:title] if args.key?(:title) @range = args[:range] if args.key?(:range) @sort_specs = args[:sort_specs] if args.key?(:sort_specs) - @named_range_id = args[:named_range_id] if args.key?(:named_range_id) - @filter_view_id = args[:filter_view_id] if args.key?(:filter_view_id) end end - # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row - # color if the row header is not set. - class BandingProperties + # Duplicates the contents of a sheet. + class DuplicateSheetRequest include Google::Apis::Core::Hashable + # The sheet to duplicate. + # Corresponds to the JSON property `sourceSheetId` + # @return [Fixnum] + attr_accessor :source_sheet_id + + # If set, the ID of the new sheet. If not set, an ID is chosen. + # If set, the ID must not conflict with any existing sheet ID. + # If set, it must be non-negative. + # Corresponds to the JSON property `newSheetId` + # @return [Fixnum] + attr_accessor :new_sheet_id + + # The zero-based index where the new sheet should be inserted. + # The index of all sheets after this are incremented. + # Corresponds to the JSON property `insertSheetIndex` + # @return [Fixnum] + attr_accessor :insert_sheet_index + + # The name of the new sheet. If empty, a new name is chosen for you. + # Corresponds to the JSON property `newSheetName` + # @return [String] + attr_accessor :new_sheet_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_sheet_id = args[:source_sheet_id] if args.key?(:source_sheet_id) + @new_sheet_id = args[:new_sheet_id] if args.key?(:new_sheet_id) + @insert_sheet_index = args[:insert_sheet_index] if args.key?(:insert_sheet_index) + @new_sheet_name = args[:new_sheet_name] if args.key?(:new_sheet_name) + end + end + + # The result of adding a filter view. + class AddFilterViewResponse + include Google::Apis::Core::Hashable + + # A filter view. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::SheetsV4::FilterView] + attr_accessor :filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + end + end + + # The result of duplicating a sheet. + class DuplicateSheetResponse + include Google::Apis::Core::Hashable + + # Properties of a sheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SheetProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + end + end + + # A border along a cell. + class Border + include Google::Apis::Core::Hashable + + # The style of the border. + # Corresponds to the JSON property `style` + # @return [String] + attr_accessor :style + + # The width of the border, in pixels. + # Deprecated; the width is determined by the "style" field. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various # languages over compactness; for example, the fields of this representation @@ -5964,9 +4014,461 @@ module Google # return resultBuilder.join(''); # `; # // ... - # Corresponds to the JSON property `secondBandColor` + # Corresponds to the JSON property `color` # @return [Google::Apis::SheetsV4::Color] - attr_accessor :second_band_color + attr_accessor :color + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @style = args[:style] if args.key?(:style) + @width = args[:width] if args.key?(:width) + @color = args[:color] if args.key?(:color) + end + end + + # Adds a named range to the spreadsheet. + class AddNamedRangeRequest + include Google::Apis::Core::Hashable + + # A named range. + # Corresponds to the JSON property `namedRange` + # @return [Google::Apis::SheetsV4::NamedRange] + attr_accessor :named_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @named_range = args[:named_range] if args.key?(:named_range) + end + end + + # The result of adding a chart to a spreadsheet. + class AddChartResponse + include Google::Apis::Core::Hashable + + # A chart embedded in a sheet. + # Corresponds to the JSON property `chart` + # @return [Google::Apis::SheetsV4::EmbeddedChart] + attr_accessor :chart + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart = args[:chart] if args.key?(:chart) + end + end + + # Adds a new banded range to the spreadsheet. + class AddBandingRequest + include Google::Apis::Core::Hashable + + # A banded (alternating colors) range in a sheet. + # Corresponds to the JSON property `bandedRange` + # @return [Google::Apis::SheetsV4::BandedRange] + attr_accessor :banded_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @banded_range = args[:banded_range] if args.key?(:banded_range) + end + end + + # Adds new cells after the last row with data in a sheet, + # inserting new rows into the sheet if necessary. + class AppendCellsRequest + include Google::Apis::Core::Hashable + + # The sheet ID to append the data to. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The data to append. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # The fields of CellData that should be updated. + # At least one field must be specified. + # The root is the CellData; 'row.values.' should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @rows = args[:rows] if args.key?(:rows) + @fields = args[:fields] if args.key?(:fields) + end + end + + # Data about each cell in a row. + class RowData + include Google::Apis::Core::Hashable + + # The values in the row, one per column. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # A single series of data in a chart. + # For example, if charting stock prices over time, multiple series may exist, + # one for the "Open Price", "High Price", "Low Price" and "Close Price". + class BasicChartSeries + include Google::Apis::Core::Hashable + + # The data included in a domain or series. + # Corresponds to the JSON property `series` + # @return [Google::Apis::SheetsV4::ChartData] + attr_accessor :series + + # The minor axis that will specify the range of values for this series. + # For example, if charting stocks over time, the "Volume" series + # may want to be pinned to the right with the prices pinned to the left, + # because the scale of trading volume is different than the scale of + # prices. + # It is an error to specify an axis that isn't a valid minor axis + # for the chart's type. + # Corresponds to the JSON property `targetAxis` + # @return [String] + attr_accessor :target_axis + + # The type of this series. Valid only if the + # chartType is + # COMBO. + # Different types will change the way the series is visualized. + # Only LINE, AREA, + # and COLUMN are supported. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @series = args[:series] if args.key?(:series) + @target_axis = args[:target_axis] if args.key?(:target_axis) + @type = args[:type] if args.key?(:type) + end + end + + # A named range. + class NamedRange + include Google::Apis::Core::Hashable + + # The ID of the named range. + # Corresponds to the JSON property `namedRangeId` + # @return [String] + attr_accessor :named_range_id + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # The name of the named range. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @named_range_id = args[:named_range_id] if args.key?(:named_range_id) + @range = args[:range] if args.key?(:range) + @name = args[:name] if args.key?(:name) + end + end + + # Updates all cells in the range to the values in the given Cell object. + # Only the fields listed in the fields field are updated; others are + # unchanged. + # If writing a cell with a formula, the formula's ranges will automatically + # increment for each field in the range. + # For example, if writing a cell with formula `=A1` into range B2:C4, + # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, + # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. + # To keep the formula's ranges static, use the `$` indicator. + # For example, use the formula `=$A$1` to prevent both the row and the + # column from incrementing. + class RepeatCellRequest + include Google::Apis::Core::Hashable + + # Data about a specific cell. + # Corresponds to the JSON property `cell` + # @return [Google::Apis::SheetsV4::CellData] + attr_accessor :cell + + # The fields that should be updated. At least one field must be specified. + # The root `cell` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cell = args[:cell] if args.key?(:cell) + @fields = args[:fields] if args.key?(:fields) + @range = args[:range] if args.key?(:range) + end + end + + # The specification for a basic chart. See BasicChartType for the list + # of charts this supports. + class BasicChartSpec + include Google::Apis::Core::Hashable + + # The type of the chart. + # Corresponds to the JSON property `chartType` + # @return [String] + attr_accessor :chart_type + + # The domain of data this is charting. + # Only a single domain is currently supported. + # Corresponds to the JSON property `domains` + # @return [Array] + attr_accessor :domains + + # The number of rows or columns in the data that are "headers". + # If not set, Google Sheets will guess how many rows are headers based + # on the data. + # (Note that BasicChartAxis.title may override the axis title + # inferred from the header values.) + # Corresponds to the JSON property `headerCount` + # @return [Fixnum] + attr_accessor :header_count + + # The data this chart is visualizing. + # Corresponds to the JSON property `series` + # @return [Array] + attr_accessor :series + + # The position of the chart legend. + # Corresponds to the JSON property `legendPosition` + # @return [String] + attr_accessor :legend_position + + # The axis on the chart. + # Corresponds to the JSON property `axis` + # @return [Array] + attr_accessor :axis + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart_type = args[:chart_type] if args.key?(:chart_type) + @domains = args[:domains] if args.key?(:domains) + @header_count = args[:header_count] if args.key?(:header_count) + @series = args[:series] if args.key?(:series) + @legend_position = args[:legend_position] if args.key?(:legend_position) + @axis = args[:axis] if args.key?(:axis) + end + end + + # Update an embedded object's position (such as a moving or resizing a + # chart or image). + class UpdateEmbeddedObjectPositionRequest + include Google::Apis::Core::Hashable + + # The position of an embedded object such as a chart. + # Corresponds to the JSON property `newPosition` + # @return [Google::Apis::SheetsV4::EmbeddedObjectPosition] + attr_accessor :new_position + + # The ID of the object to moved. + # Corresponds to the JSON property `objectId` + # @return [Fixnum] + attr_accessor :object_id_prop + + # The fields of OverlayPosition + # that should be updated when setting a new position. Used only if + # newPosition.overlayPosition + # is set, in which case at least one field must + # be specified. The root `newPosition.overlayPosition` is implied and + # should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @new_position = args[:new_position] if args.key?(:new_position) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @fields = args[:fields] if args.key?(:fields) + end + end + + # Sets the basic filter associated with a sheet. + class SetBasicFilterRequest + include Google::Apis::Core::Hashable + + # The default filter associated with a sheet. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::SheetsV4::BasicFilter] + attr_accessor :filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + end + end + + # Automatically resizes one or more dimensions based on the contents + # of the cells in that dimension. + class AutoResizeDimensionsRequest + include Google::Apis::Core::Hashable + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + # Corresponds to the JSON property `dimensions` + # @return [Google::Apis::SheetsV4::DimensionRange] + attr_accessor :dimensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + end + end + + # The result of a filter view being duplicated. + class DuplicateFilterViewResponse + include Google::Apis::Core::Hashable + + # A filter view. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::SheetsV4::FilterView] + attr_accessor :filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + end + end + + # Properties referring a single dimension (either row or column). If both + # BandedRange.row_properties and BandedRange.column_properties are + # set, the fill colors are applied to cells according to the following rules: + # * header_color and footer_color take priority over band colors. + # * first_band_color takes priority over second_band_color. + # * row_properties takes priority over column_properties. + # For example, the first row color takes priority over the first column + # color, but the first column color takes priority over the second row color. + # Similarly, the row header takes priority over the column header in the + # top left cell, but the column header takes priority over the first row + # color if the row header is not set. + class BandingProperties + include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various @@ -6174,6 +4676,109 @@ module Google # @return [Google::Apis::SheetsV4::Color] attr_accessor :header_color + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + # Corresponds to the JSON property `secondBandColor` + # @return [Google::Apis::SheetsV4::Color] + attr_accessor :second_band_color + # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various # languages over compactness; for example, the fields of this representation @@ -6283,21 +4888,45 @@ module Google # Update properties of this object def update!(**args) - @second_band_color = args[:second_band_color] if args.key?(:second_band_color) @footer_color = args[:footer_color] if args.key?(:footer_color) @header_color = args[:header_color] if args.key?(:header_color) + @second_band_color = args[:second_band_color] if args.key?(:second_band_color) @first_band_color = args[:first_band_color] if args.key?(:first_band_color) end end - # The result of adding a new protected range. - class AddProtectedRangeResponse + # A single grouping (either row or column) in a pivot table. + class PivotGroup include Google::Apis::Core::Hashable - # A protected range. - # Corresponds to the JSON property `protectedRange` - # @return [Google::Apis::SheetsV4::ProtectedRange] - attr_accessor :protected_range + # The order the values in this group should be sorted. + # Corresponds to the JSON property `sortOrder` + # @return [String] + attr_accessor :sort_order + + # The column offset of the source range that this grouping is based on. + # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` + # means this group refers to column `C`, whereas the offset `1` would refer + # to column `D`. + # Corresponds to the JSON property `sourceColumnOffset` + # @return [Fixnum] + attr_accessor :source_column_offset + + # True if the pivot table should include the totals for this grouping. + # Corresponds to the JSON property `showTotals` + # @return [Boolean] + attr_accessor :show_totals + alias_method :show_totals?, :show_totals + + # Information about which values in a pivot group should be used for sorting. + # Corresponds to the JSON property `valueBucket` + # @return [Google::Apis::SheetsV4::PivotGroupSortValueBucket] + attr_accessor :value_bucket + + # Metadata about values in the grouping. + # Corresponds to the JSON property `valueMetadata` + # @return [Array] + attr_accessor :value_metadata def initialize(**args) update!(**args) @@ -6305,14 +4934,319 @@ module Google # Update properties of this object def update!(**args) - @protected_range = args[:protected_range] if args.key?(:protected_range) + @sort_order = args[:sort_order] if args.key?(:sort_order) + @source_column_offset = args[:source_column_offset] if args.key?(:source_column_offset) + @show_totals = args[:show_totals] if args.key?(:show_totals) + @value_bucket = args[:value_bucket] if args.key?(:value_bucket) + @value_metadata = args[:value_metadata] if args.key?(:value_metadata) end end - # The default filter associated with a sheet. - class BasicFilter + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + class GridRange include Google::Apis::Core::Hashable + # The sheet this range is on. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The start column (inclusive) of the range, or not set if unbounded. + # Corresponds to the JSON property `startColumnIndex` + # @return [Fixnum] + attr_accessor :start_column_index + + # The start row (inclusive) of the range, or not set if unbounded. + # Corresponds to the JSON property `startRowIndex` + # @return [Fixnum] + attr_accessor :start_row_index + + # The end row (exclusive) of the range, or not set if unbounded. + # Corresponds to the JSON property `endRowIndex` + # @return [Fixnum] + attr_accessor :end_row_index + + # The end column (exclusive) of the range, or not set if unbounded. + # Corresponds to the JSON property `endColumnIndex` + # @return [Fixnum] + attr_accessor :end_column_index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @start_column_index = args[:start_column_index] if args.key?(:start_column_index) + @start_row_index = args[:start_row_index] if args.key?(:start_row_index) + @end_row_index = args[:end_row_index] if args.key?(:end_row_index) + @end_column_index = args[:end_column_index] if args.key?(:end_column_index) + end + end + + # Deletes the requested sheet. + class DeleteSheetRequest + include Google::Apis::Core::Hashable + + # The ID of the sheet to delete. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + end + end + + # Updates properties of the supplied banded range. + class UpdateBandingRequest + include Google::Apis::Core::Hashable + + # A banded (alternating colors) range in a sheet. + # Corresponds to the JSON property `bandedRange` + # @return [Google::Apis::SheetsV4::BandedRange] + attr_accessor :banded_range + + # The fields that should be updated. At least one field must be specified. + # The root `bandedRange` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @banded_range = args[:banded_range] if args.key?(:banded_range) + @fields = args[:fields] if args.key?(:fields) + end + end + + # The data included in a domain or series. + class ChartData + include Google::Apis::Core::Hashable + + # Source ranges for a chart. + # Corresponds to the JSON property `sourceRange` + # @return [Google::Apis::SheetsV4::ChartSourceRange] + attr_accessor :source_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_range = args[:source_range] if args.key?(:source_range) + end + end + + # A sheet in a spreadsheet. + class Sheet + include Google::Apis::Core::Hashable + + # Properties of a sheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SheetProperties] + attr_accessor :properties + + # The specifications of every chart on this sheet. + # Corresponds to the JSON property `charts` + # @return [Array] + attr_accessor :charts + + # The filter views in this sheet. + # Corresponds to the JSON property `filterViews` + # @return [Array] + attr_accessor :filter_views + + # The conditional format rules in this sheet. + # Corresponds to the JSON property `conditionalFormats` + # @return [Array] + attr_accessor :conditional_formats + + # The protected ranges in this sheet. + # Corresponds to the JSON property `protectedRanges` + # @return [Array] + attr_accessor :protected_ranges + + # The default filter associated with a sheet. + # Corresponds to the JSON property `basicFilter` + # @return [Google::Apis::SheetsV4::BasicFilter] + attr_accessor :basic_filter + + # The ranges that are merged together. + # Corresponds to the JSON property `merges` + # @return [Array] + attr_accessor :merges + + # Data in the grid, if this is a grid sheet. + # The number of GridData objects returned is dependent on the number of + # ranges requested on this sheet. For example, if this is representing + # `Sheet1`, and the spreadsheet was requested with ranges + # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a + # startRow/startColumn of `0`, + # while the second one will have `startRow 14` (zero-based row 15), + # and `startColumn 3` (zero-based column D). + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # The banded (i.e. alternating colors) ranges on this sheet. + # Corresponds to the JSON property `bandedRanges` + # @return [Array] + attr_accessor :banded_ranges + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + @charts = args[:charts] if args.key?(:charts) + @filter_views = args[:filter_views] if args.key?(:filter_views) + @conditional_formats = args[:conditional_formats] if args.key?(:conditional_formats) + @protected_ranges = args[:protected_ranges] if args.key?(:protected_ranges) + @basic_filter = args[:basic_filter] if args.key?(:basic_filter) + @merges = args[:merges] if args.key?(:merges) + @data = args[:data] if args.key?(:data) + @banded_ranges = args[:banded_ranges] if args.key?(:banded_ranges) + end + end + + # Copies data from the source to the destination. + class CopyPasteRequest + include Google::Apis::Core::Hashable + + # What kind of data to paste. + # Corresponds to the JSON property `pasteType` + # @return [String] + attr_accessor :paste_type + + # How that data should be oriented when pasting. + # Corresponds to the JSON property `pasteOrientation` + # @return [String] + attr_accessor :paste_orientation + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `source` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :source + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `destination` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @paste_type = args[:paste_type] if args.key?(:paste_type) + @paste_orientation = args[:paste_orientation] if args.key?(:paste_orientation) + @source = args[:source] if args.key?(:source) + @destination = args[:destination] if args.key?(:destination) + end + end + + # Updates all cells in a range with new data. + class UpdateCellsRequest + include Google::Apis::Core::Hashable + + # The data to write. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # The fields of CellData that should be updated. + # At least one field must be specified. + # The root is the CellData; 'row.values.' should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # A coordinate in a sheet. + # All indexes are zero-based. + # Corresponds to the JSON property `start` + # @return [Google::Apis::SheetsV4::GridCoordinate] + attr_accessor :start + # A range on a sheet. # All indexes are zero-based. # Indexes are half open, e.g the start index is inclusive @@ -6339,18 +5273,53 @@ module Google # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The criteria for showing/hiding values per column. - # The map's key is the column index, and the value is the criteria for - # that column. - # Corresponds to the JSON property `criteria` - # @return [Hash] - attr_accessor :criteria + def initialize(**args) + update!(**args) + end - # The sort order per column. Later specifications are used when values - # are equal in the earlier specifications. - # Corresponds to the JSON property `sortSpecs` - # @return [Array] - attr_accessor :sort_specs + # Update properties of this object + def update!(**args) + @rows = args[:rows] if args.key?(:rows) + @fields = args[:fields] if args.key?(:fields) + @start = args[:start] if args.key?(:start) + @range = args[:range] if args.key?(:range) + end + end + + # The kinds of value that a cell in a spreadsheet can have. + class ExtendedValue + include Google::Apis::Core::Hashable + + # Represents a formula. + # Corresponds to the JSON property `formulaValue` + # @return [String] + attr_accessor :formula_value + + # An error in a cell. + # Corresponds to the JSON property `errorValue` + # @return [Google::Apis::SheetsV4::ErrorValue] + attr_accessor :error_value + + # Represents a boolean value. + # Corresponds to the JSON property `boolValue` + # @return [Boolean] + attr_accessor :bool_value + alias_method :bool_value?, :bool_value + + # Represents a double value. + # Note: Dates, Times and DateTimes are represented as doubles in + # "serial number" format. + # Corresponds to the JSON property `numberValue` + # @return [Float] + attr_accessor :number_value + + # Represents a string value. + # Leading single quotes are not included. For example, if the user typed + # `'123` into the UI, this would be represented as a `stringValue` of + # `"123"`. + # Corresponds to the JSON property `stringValue` + # @return [String] + attr_accessor :string_value def initialize(**args) update!(**args) @@ -6358,9 +5327,1040 @@ module Google # Update properties of this object def update!(**args) + @formula_value = args[:formula_value] if args.key?(:formula_value) + @error_value = args[:error_value] if args.key?(:error_value) + @bool_value = args[:bool_value] if args.key?(:bool_value) + @number_value = args[:number_value] if args.key?(:number_value) + @string_value = args[:string_value] if args.key?(:string_value) + end + end + + # The reply for batch updating a spreadsheet. + class BatchUpdateSpreadsheetResponse + include Google::Apis::Core::Hashable + + # The spreadsheet the updates were applied to. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + # Resource that represents a spreadsheet. + # Corresponds to the JSON property `updatedSpreadsheet` + # @return [Google::Apis::SheetsV4::Spreadsheet] + attr_accessor :updated_spreadsheet + + # The reply of the updates. This maps 1:1 with the updates, although + # replies to some requests may be empty. + # Corresponds to the JSON property `replies` + # @return [Array] + attr_accessor :replies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + @updated_spreadsheet = args[:updated_spreadsheet] if args.key?(:updated_spreadsheet) + @replies = args[:replies] if args.key?(:replies) + end + end + + # A rule that applies a gradient color scale format, based on + # the interpolation points listed. The format of a cell will vary + # based on its contents as compared to the values of the interpolation + # points. + class GradientRule + include Google::Apis::Core::Hashable + + # A single interpolation point on a gradient conditional format. + # These pin the gradient color scale according to the color, + # type and value chosen. + # Corresponds to the JSON property `maxpoint` + # @return [Google::Apis::SheetsV4::InterpolationPoint] + attr_accessor :maxpoint + + # A single interpolation point on a gradient conditional format. + # These pin the gradient color scale according to the color, + # type and value chosen. + # Corresponds to the JSON property `midpoint` + # @return [Google::Apis::SheetsV4::InterpolationPoint] + attr_accessor :midpoint + + # A single interpolation point on a gradient conditional format. + # These pin the gradient color scale according to the color, + # type and value chosen. + # Corresponds to the JSON property `minpoint` + # @return [Google::Apis::SheetsV4::InterpolationPoint] + attr_accessor :minpoint + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @maxpoint = args[:maxpoint] if args.key?(:maxpoint) + @midpoint = args[:midpoint] if args.key?(:midpoint) + @minpoint = args[:minpoint] if args.key?(:minpoint) + end + end + + # Moves data from the source to the destination. + class CutPasteRequest + include Google::Apis::Core::Hashable + + # What kind of data to paste. All the source data will be cut, regardless + # of what is pasted. + # Corresponds to the JSON property `pasteType` + # @return [String] + attr_accessor :paste_type + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `source` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :source + + # A coordinate in a sheet. + # All indexes are zero-based. + # Corresponds to the JSON property `destination` + # @return [Google::Apis::SheetsV4::GridCoordinate] + attr_accessor :destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @paste_type = args[:paste_type] if args.key?(:paste_type) + @source = args[:source] if args.key?(:source) + @destination = args[:destination] if args.key?(:destination) + end + end + + # The location an object is overlaid on top of a grid. + class OverlayPosition + include Google::Apis::Core::Hashable + + # The width of the object, in pixels. Defaults to 600. + # Corresponds to the JSON property `widthPixels` + # @return [Fixnum] + attr_accessor :width_pixels + + # A coordinate in a sheet. + # All indexes are zero-based. + # Corresponds to the JSON property `anchorCell` + # @return [Google::Apis::SheetsV4::GridCoordinate] + attr_accessor :anchor_cell + + # The horizontal offset, in pixels, that the object is offset + # from the anchor cell. + # Corresponds to the JSON property `offsetXPixels` + # @return [Fixnum] + attr_accessor :offset_x_pixels + + # The height of the object, in pixels. Defaults to 371. + # Corresponds to the JSON property `heightPixels` + # @return [Fixnum] + attr_accessor :height_pixels + + # The vertical offset, in pixels, that the object is offset + # from the anchor cell. + # Corresponds to the JSON property `offsetYPixels` + # @return [Fixnum] + attr_accessor :offset_y_pixels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @width_pixels = args[:width_pixels] if args.key?(:width_pixels) + @anchor_cell = args[:anchor_cell] if args.key?(:anchor_cell) + @offset_x_pixels = args[:offset_x_pixels] if args.key?(:offset_x_pixels) + @height_pixels = args[:height_pixels] if args.key?(:height_pixels) + @offset_y_pixels = args[:offset_y_pixels] if args.key?(:offset_y_pixels) + end + end + + # Fills in more data based on existing data. + class AutoFillRequest + include Google::Apis::Core::Hashable + + # True if we should generate data with the "alternate" series. + # This differs based on the type and amount of source data. + # Corresponds to the JSON property `useAlternateSeries` + # @return [Boolean] + attr_accessor :use_alternate_series + alias_method :use_alternate_series?, :use_alternate_series + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + # A combination of a source range and how to extend that source. + # Corresponds to the JSON property `sourceAndDestination` + # @return [Google::Apis::SheetsV4::SourceAndDestination] + attr_accessor :source_and_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @use_alternate_series = args[:use_alternate_series] if args.key?(:use_alternate_series) @range = args[:range] if args.key?(:range) - @criteria = args[:criteria] if args.key?(:criteria) - @sort_specs = args[:sort_specs] if args.key?(:sort_specs) + @source_and_destination = args[:source_and_destination] if args.key?(:source_and_destination) + end + end + + # A pie chart. + class PieChartSpec + include Google::Apis::Core::Hashable + + # Where the legend of the pie chart should be drawn. + # Corresponds to the JSON property `legendPosition` + # @return [String] + attr_accessor :legend_position + + # The data included in a domain or series. + # Corresponds to the JSON property `series` + # @return [Google::Apis::SheetsV4::ChartData] + attr_accessor :series + + # The size of the hole in the pie chart. + # Corresponds to the JSON property `pieHole` + # @return [Float] + attr_accessor :pie_hole + + # True if the pie is three dimensional. + # Corresponds to the JSON property `threeDimensional` + # @return [Boolean] + attr_accessor :three_dimensional + alias_method :three_dimensional?, :three_dimensional + + # The data included in a domain or series. + # Corresponds to the JSON property `domain` + # @return [Google::Apis::SheetsV4::ChartData] + attr_accessor :domain + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @legend_position = args[:legend_position] if args.key?(:legend_position) + @series = args[:series] if args.key?(:series) + @pie_hole = args[:pie_hole] if args.key?(:pie_hole) + @three_dimensional = args[:three_dimensional] if args.key?(:three_dimensional) + @domain = args[:domain] if args.key?(:domain) + end + end + + # Updates properties of the sheet with the specified + # sheetId. + class UpdateSheetPropertiesRequest + include Google::Apis::Core::Hashable + + # The fields that should be updated. At least one field must be specified. + # The root `properties` is implied and should not be specified. + # A single `"*"` can be used as short-hand for listing every field. + # Corresponds to the JSON property `fields` + # @return [String] + attr_accessor :fields + + # Properties of a sheet. + # Corresponds to the JSON property `properties` + # @return [Google::Apis::SheetsV4::SheetProperties] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @properties = args[:properties] if args.key?(:properties) + end + end + + # A rule that may or may not match, depending on the condition. + class BooleanRule + include Google::Apis::Core::Hashable + + # A condition that can evaluate to true or false. + # BooleanConditions are used by conditional formatting, + # data validation, and the criteria in filters. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::SheetsV4::BooleanCondition] + attr_accessor :condition + + # The format of a cell. + # Corresponds to the JSON property `format` + # @return [Google::Apis::SheetsV4::CellFormat] + attr_accessor :format + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @format = args[:format] if args.key?(:format) + end + end + + # Appends rows or columns to the end of a sheet. + class AppendDimensionRequest + include Google::Apis::Core::Hashable + + # The sheet to append rows or columns to. + # Corresponds to the JSON property `sheetId` + # @return [Fixnum] + attr_accessor :sheet_id + + # The number of rows or columns to append. + # Corresponds to the JSON property `length` + # @return [Fixnum] + attr_accessor :length + + # Whether rows or columns should be appended. + # Corresponds to the JSON property `dimension` + # @return [String] + attr_accessor :dimension + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sheet_id = args[:sheet_id] if args.key?(:sheet_id) + @length = args[:length] if args.key?(:length) + @dimension = args[:dimension] if args.key?(:dimension) + end + end + + # Adds a filter view. + class AddFilterViewRequest + include Google::Apis::Core::Hashable + + # A filter view. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::SheetsV4::FilterView] + attr_accessor :filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + end + end + + # Properties of a grid. + class GridProperties + include Google::Apis::Core::Hashable + + # The number of rows in the grid. + # Corresponds to the JSON property `rowCount` + # @return [Fixnum] + attr_accessor :row_count + + # The number of columns in the grid. + # Corresponds to the JSON property `columnCount` + # @return [Fixnum] + attr_accessor :column_count + + # The number of rows that are frozen in the grid. + # Corresponds to the JSON property `frozenRowCount` + # @return [Fixnum] + attr_accessor :frozen_row_count + + # The number of columns that are frozen in the grid. + # Corresponds to the JSON property `frozenColumnCount` + # @return [Fixnum] + attr_accessor :frozen_column_count + + # True if the grid isn't showing gridlines in the UI. + # Corresponds to the JSON property `hideGridlines` + # @return [Boolean] + attr_accessor :hide_gridlines + alias_method :hide_gridlines?, :hide_gridlines + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @row_count = args[:row_count] if args.key?(:row_count) + @column_count = args[:column_count] if args.key?(:column_count) + @frozen_row_count = args[:frozen_row_count] if args.key?(:frozen_row_count) + @frozen_column_count = args[:frozen_column_count] if args.key?(:frozen_column_count) + @hide_gridlines = args[:hide_gridlines] if args.key?(:hide_gridlines) + end + end + + # Removes the named range with the given ID from the spreadsheet. + class DeleteNamedRangeRequest + include Google::Apis::Core::Hashable + + # The ID of the named range to delete. + # Corresponds to the JSON property `namedRangeId` + # @return [String] + attr_accessor :named_range_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @named_range_id = args[:named_range_id] if args.key?(:named_range_id) + end + end + + # Adds a chart to a sheet in the spreadsheet. + class AddChartRequest + include Google::Apis::Core::Hashable + + # A chart embedded in a sheet. + # Corresponds to the JSON property `chart` + # @return [Google::Apis::SheetsV4::EmbeddedChart] + attr_accessor :chart + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @chart = args[:chart] if args.key?(:chart) + end + end + + # Sets a data validation rule to every cell in the range. + # To clear validation in a range, call this with no rule specified. + class SetDataValidationRequest + include Google::Apis::Core::Hashable + + # A data validation rule. + # Corresponds to the JSON property `rule` + # @return [Google::Apis::SheetsV4::DataValidationRule] + attr_accessor :rule + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rule = args[:rule] if args.key?(:rule) + @range = args[:range] if args.key?(:range) + end + end + + # A single kind of update to apply to a spreadsheet. + class Request + include Google::Apis::Core::Hashable + + # Update an embedded object's position (such as a moving or resizing a + # chart or image). + # Corresponds to the JSON property `updateEmbeddedObjectPosition` + # @return [Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest] + attr_accessor :update_embedded_object_position + + # Removes the named range with the given ID from the spreadsheet. + # Corresponds to the JSON property `deleteNamedRange` + # @return [Google::Apis::SheetsV4::DeleteNamedRangeRequest] + attr_accessor :delete_named_range + + # Updates properties of the named range with the specified + # namedRangeId. + # Corresponds to the JSON property `updateNamedRange` + # @return [Google::Apis::SheetsV4::UpdateNamedRangeRequest] + attr_accessor :update_named_range + + # Adds a filter view. + # Corresponds to the JSON property `addFilterView` + # @return [Google::Apis::SheetsV4::AddFilterViewRequest] + attr_accessor :add_filter_view + + # Updates properties of a spreadsheet. + # Corresponds to the JSON property `updateSpreadsheetProperties` + # @return [Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest] + attr_accessor :update_spreadsheet_properties + + # Appends rows or columns to the end of a sheet. + # Corresponds to the JSON property `appendDimension` + # @return [Google::Apis::SheetsV4::AppendDimensionRequest] + attr_accessor :append_dimension + + # Unmerges cells in the given range. + # Corresponds to the JSON property `unmergeCells` + # @return [Google::Apis::SheetsV4::UnmergeCellsRequest] + attr_accessor :unmerge_cells + + # Inserts cells into a range, shifting the existing cells over or down. + # Corresponds to the JSON property `insertRange` + # @return [Google::Apis::SheetsV4::InsertRangeRequest] + attr_accessor :insert_range + + # Updates an existing protected range with the specified + # protectedRangeId. + # Corresponds to the JSON property `updateProtectedRange` + # @return [Google::Apis::SheetsV4::UpdateProtectedRangeRequest] + attr_accessor :update_protected_range + + # Deletes a particular filter view. + # Corresponds to the JSON property `deleteFilterView` + # @return [Google::Apis::SheetsV4::DeleteFilterViewRequest] + attr_accessor :delete_filter_view + + # Clears the basic filter, if any exists on the sheet. + # Corresponds to the JSON property `clearBasicFilter` + # @return [Google::Apis::SheetsV4::ClearBasicFilterRequest] + attr_accessor :clear_basic_filter + + # Sorts data in rows based on a sort order per column. + # Corresponds to the JSON property `sortRange` + # @return [Google::Apis::SheetsV4::SortRangeRequest] + attr_accessor :sort_range + + # Updates all cells in the range to the values in the given Cell object. + # Only the fields listed in the fields field are updated; others are + # unchanged. + # If writing a cell with a formula, the formula's ranges will automatically + # increment for each field in the range. + # For example, if writing a cell with formula `=A1` into range B2:C4, + # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, + # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. + # To keep the formula's ranges static, use the `$` indicator. + # For example, use the formula `=$A$1` to prevent both the row and the + # column from incrementing. + # Corresponds to the JSON property `repeatCell` + # @return [Google::Apis::SheetsV4::RepeatCellRequest] + attr_accessor :repeat_cell + + # Sets a data validation rule to every cell in the range. + # To clear validation in a range, call this with no rule specified. + # Corresponds to the JSON property `setDataValidation` + # @return [Google::Apis::SheetsV4::SetDataValidationRequest] + attr_accessor :set_data_validation + + # Updates all cells in a range with new data. + # Corresponds to the JSON property `updateCells` + # @return [Google::Apis::SheetsV4::UpdateCellsRequest] + attr_accessor :update_cells + + # Adds a new sheet. + # When a sheet is added at a given index, + # all subsequent sheets' indexes are incremented. + # To add an object sheet, use AddChartRequest instead and specify + # EmbeddedObjectPosition.sheetId or + # EmbeddedObjectPosition.newSheet. + # Corresponds to the JSON property `addSheet` + # @return [Google::Apis::SheetsV4::AddSheetRequest] + attr_accessor :add_sheet + + # Updates properties of the filter view. + # Corresponds to the JSON property `updateFilterView` + # @return [Google::Apis::SheetsV4::UpdateFilterViewRequest] + attr_accessor :update_filter_view + + # Updates properties of the sheet with the specified + # sheetId. + # Corresponds to the JSON property `updateSheetProperties` + # @return [Google::Apis::SheetsV4::UpdateSheetPropertiesRequest] + attr_accessor :update_sheet_properties + + # Updates properties of dimensions within the specified range. + # Corresponds to the JSON property `updateDimensionProperties` + # @return [Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest] + attr_accessor :update_dimension_properties + + # Deletes the requested sheet. + # Corresponds to the JSON property `deleteSheet` + # @return [Google::Apis::SheetsV4::DeleteSheetRequest] + attr_accessor :delete_sheet + + # Finds and replaces data in cells over a range, sheet, or all sheets. + # Corresponds to the JSON property `findReplace` + # @return [Google::Apis::SheetsV4::FindReplaceRequest] + attr_accessor :find_replace + + # Adds a new protected range. + # Corresponds to the JSON property `addProtectedRange` + # @return [Google::Apis::SheetsV4::AddProtectedRangeRequest] + attr_accessor :add_protected_range + + # Deletes the protected range with the given ID. + # Corresponds to the JSON property `deleteProtectedRange` + # @return [Google::Apis::SheetsV4::DeleteProtectedRangeRequest] + attr_accessor :delete_protected_range + + # Updates a conditional format rule at the given index, + # or moves a conditional format rule to another index. + # Corresponds to the JSON property `updateConditionalFormatRule` + # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest] + attr_accessor :update_conditional_format_rule + + # Sets the basic filter associated with a sheet. + # Corresponds to the JSON property `setBasicFilter` + # @return [Google::Apis::SheetsV4::SetBasicFilterRequest] + attr_accessor :set_basic_filter + + # Merges all cells in the range. + # Corresponds to the JSON property `mergeCells` + # @return [Google::Apis::SheetsV4::MergeCellsRequest] + attr_accessor :merge_cells + + # Updates properties of the supplied banded range. + # Corresponds to the JSON property `updateBanding` + # @return [Google::Apis::SheetsV4::UpdateBandingRequest] + attr_accessor :update_banding + + # Adds a chart to a sheet in the spreadsheet. + # Corresponds to the JSON property `addChart` + # @return [Google::Apis::SheetsV4::AddChartRequest] + attr_accessor :add_chart + + # Deletes a conditional format rule at the given index. + # All subsequent rules' indexes are decremented. + # Corresponds to the JSON property `deleteConditionalFormatRule` + # @return [Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest] + attr_accessor :delete_conditional_format_rule + + # Adds a new banded range to the spreadsheet. + # Corresponds to the JSON property `addBanding` + # @return [Google::Apis::SheetsV4::AddBandingRequest] + attr_accessor :add_banding + + # Removes the banded range with the given ID from the spreadsheet. + # Corresponds to the JSON property `deleteBanding` + # @return [Google::Apis::SheetsV4::DeleteBandingRequest] + attr_accessor :delete_banding + + # Updates a chart's specifications. + # (This does not move or resize a chart. To move or resize a chart, use + # UpdateEmbeddedObjectPositionRequest.) + # Corresponds to the JSON property `updateChartSpec` + # @return [Google::Apis::SheetsV4::UpdateChartSpecRequest] + attr_accessor :update_chart_spec + + # Deletes a range of cells, shifting other cells into the deleted area. + # Corresponds to the JSON property `deleteRange` + # @return [Google::Apis::SheetsV4::DeleteRangeRequest] + attr_accessor :delete_range + + # Deletes the dimensions from the sheet. + # Corresponds to the JSON property `deleteDimension` + # @return [Google::Apis::SheetsV4::DeleteDimensionRequest] + attr_accessor :delete_dimension + + # Deletes the embedded object with the given ID. + # Corresponds to the JSON property `deleteEmbeddedObject` + # @return [Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest] + attr_accessor :delete_embedded_object + + # Inserts data into the spreadsheet starting at the specified coordinate. + # Corresponds to the JSON property `pasteData` + # @return [Google::Apis::SheetsV4::PasteDataRequest] + attr_accessor :paste_data + + # Adds a new conditional format rule at the given index. + # All subsequent rules' indexes are incremented. + # Corresponds to the JSON property `addConditionalFormatRule` + # @return [Google::Apis::SheetsV4::AddConditionalFormatRuleRequest] + attr_accessor :add_conditional_format_rule + + # Updates the borders of a range. + # If a field is not set in the request, that means the border remains as-is. + # For example, with two subsequent UpdateBordersRequest: + # 1. range: A1:A5 `` top: RED, bottom: WHITE `` + # 2. range: A1:A5 `` left: BLUE `` + # That would result in A1:A5 having a borders of + # `` top: RED, bottom: WHITE, left: BLUE ``. + # If you want to clear a border, explicitly set the style to + # NONE. + # Corresponds to the JSON property `updateBorders` + # @return [Google::Apis::SheetsV4::UpdateBordersRequest] + attr_accessor :update_borders + + # Automatically resizes one or more dimensions based on the contents + # of the cells in that dimension. + # Corresponds to the JSON property `autoResizeDimensions` + # @return [Google::Apis::SheetsV4::AutoResizeDimensionsRequest] + attr_accessor :auto_resize_dimensions + + # Duplicates the contents of a sheet. + # Corresponds to the JSON property `duplicateSheet` + # @return [Google::Apis::SheetsV4::DuplicateSheetRequest] + attr_accessor :duplicate_sheet + + # Duplicates a particular filter view. + # Corresponds to the JSON property `duplicateFilterView` + # @return [Google::Apis::SheetsV4::DuplicateFilterViewRequest] + attr_accessor :duplicate_filter_view + + # Moves data from the source to the destination. + # Corresponds to the JSON property `cutPaste` + # @return [Google::Apis::SheetsV4::CutPasteRequest] + attr_accessor :cut_paste + + # Adds new cells after the last row with data in a sheet, + # inserting new rows into the sheet if necessary. + # Corresponds to the JSON property `appendCells` + # @return [Google::Apis::SheetsV4::AppendCellsRequest] + attr_accessor :append_cells + + # Adds a named range to the spreadsheet. + # Corresponds to the JSON property `addNamedRange` + # @return [Google::Apis::SheetsV4::AddNamedRangeRequest] + attr_accessor :add_named_range + + # Fills in more data based on existing data. + # Corresponds to the JSON property `autoFill` + # @return [Google::Apis::SheetsV4::AutoFillRequest] + attr_accessor :auto_fill + + # Moves one or more rows or columns. + # Corresponds to the JSON property `moveDimension` + # @return [Google::Apis::SheetsV4::MoveDimensionRequest] + attr_accessor :move_dimension + + # Splits a column of text into multiple columns, + # based on a delimiter in each cell. + # Corresponds to the JSON property `textToColumns` + # @return [Google::Apis::SheetsV4::TextToColumnsRequest] + attr_accessor :text_to_columns + + # Inserts rows or columns in a sheet at a particular index. + # Corresponds to the JSON property `insertDimension` + # @return [Google::Apis::SheetsV4::InsertDimensionRequest] + attr_accessor :insert_dimension + + # Copies data from the source to the destination. + # Corresponds to the JSON property `copyPaste` + # @return [Google::Apis::SheetsV4::CopyPasteRequest] + attr_accessor :copy_paste + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @update_embedded_object_position = args[:update_embedded_object_position] if args.key?(:update_embedded_object_position) + @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range) + @update_named_range = args[:update_named_range] if args.key?(:update_named_range) + @add_filter_view = args[:add_filter_view] if args.key?(:add_filter_view) + @update_spreadsheet_properties = args[:update_spreadsheet_properties] if args.key?(:update_spreadsheet_properties) + @append_dimension = args[:append_dimension] if args.key?(:append_dimension) + @unmerge_cells = args[:unmerge_cells] if args.key?(:unmerge_cells) + @insert_range = args[:insert_range] if args.key?(:insert_range) + @update_protected_range = args[:update_protected_range] if args.key?(:update_protected_range) + @delete_filter_view = args[:delete_filter_view] if args.key?(:delete_filter_view) + @clear_basic_filter = args[:clear_basic_filter] if args.key?(:clear_basic_filter) + @sort_range = args[:sort_range] if args.key?(:sort_range) + @repeat_cell = args[:repeat_cell] if args.key?(:repeat_cell) + @set_data_validation = args[:set_data_validation] if args.key?(:set_data_validation) + @update_cells = args[:update_cells] if args.key?(:update_cells) + @add_sheet = args[:add_sheet] if args.key?(:add_sheet) + @update_filter_view = args[:update_filter_view] if args.key?(:update_filter_view) + @update_sheet_properties = args[:update_sheet_properties] if args.key?(:update_sheet_properties) + @update_dimension_properties = args[:update_dimension_properties] if args.key?(:update_dimension_properties) + @delete_sheet = args[:delete_sheet] if args.key?(:delete_sheet) + @find_replace = args[:find_replace] if args.key?(:find_replace) + @add_protected_range = args[:add_protected_range] if args.key?(:add_protected_range) + @delete_protected_range = args[:delete_protected_range] if args.key?(:delete_protected_range) + @update_conditional_format_rule = args[:update_conditional_format_rule] if args.key?(:update_conditional_format_rule) + @set_basic_filter = args[:set_basic_filter] if args.key?(:set_basic_filter) + @merge_cells = args[:merge_cells] if args.key?(:merge_cells) + @update_banding = args[:update_banding] if args.key?(:update_banding) + @add_chart = args[:add_chart] if args.key?(:add_chart) + @delete_conditional_format_rule = args[:delete_conditional_format_rule] if args.key?(:delete_conditional_format_rule) + @add_banding = args[:add_banding] if args.key?(:add_banding) + @delete_banding = args[:delete_banding] if args.key?(:delete_banding) + @update_chart_spec = args[:update_chart_spec] if args.key?(:update_chart_spec) + @delete_range = args[:delete_range] if args.key?(:delete_range) + @delete_dimension = args[:delete_dimension] if args.key?(:delete_dimension) + @delete_embedded_object = args[:delete_embedded_object] if args.key?(:delete_embedded_object) + @paste_data = args[:paste_data] if args.key?(:paste_data) + @add_conditional_format_rule = args[:add_conditional_format_rule] if args.key?(:add_conditional_format_rule) + @update_borders = args[:update_borders] if args.key?(:update_borders) + @auto_resize_dimensions = args[:auto_resize_dimensions] if args.key?(:auto_resize_dimensions) + @duplicate_sheet = args[:duplicate_sheet] if args.key?(:duplicate_sheet) + @duplicate_filter_view = args[:duplicate_filter_view] if args.key?(:duplicate_filter_view) + @cut_paste = args[:cut_paste] if args.key?(:cut_paste) + @append_cells = args[:append_cells] if args.key?(:append_cells) + @add_named_range = args[:add_named_range] if args.key?(:add_named_range) + @auto_fill = args[:auto_fill] if args.key?(:auto_fill) + @move_dimension = args[:move_dimension] if args.key?(:move_dimension) + @text_to_columns = args[:text_to_columns] if args.key?(:text_to_columns) + @insert_dimension = args[:insert_dimension] if args.key?(:insert_dimension) + @copy_paste = args[:copy_paste] if args.key?(:copy_paste) + end + end + + # The response when retrieving more than one range of values in a spreadsheet. + class BatchGetValuesResponse + include Google::Apis::Core::Hashable + + # The requested values. The order of the ValueRanges is the same as the + # order of the requested ranges. + # Corresponds to the JSON property `valueRanges` + # @return [Array] + attr_accessor :value_ranges + + # The ID of the spreadsheet the data was retrieved from. + # Corresponds to the JSON property `spreadsheetId` + # @return [String] + attr_accessor :spreadsheet_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value_ranges = args[:value_ranges] if args.key?(:value_ranges) + @spreadsheet_id = args[:spreadsheet_id] if args.key?(:spreadsheet_id) + end + end + + # Inserts rows or columns in a sheet at a particular index. + class InsertDimensionRequest + include Google::Apis::Core::Hashable + + # Whether dimension properties should be extended from the dimensions + # before or after the newly inserted dimensions. + # True to inherit from the dimensions before (in which case the start + # index must be greater than 0), and false to inherit from the dimensions + # after. + # For example, if row index 0 has red background and row index 1 + # has a green background, then inserting 2 rows at index 1 can inherit + # either the green or red background. If `inheritFromBefore` is true, + # the two new rows will be red (because the row before the insertion point + # was red), whereas if `inheritFromBefore` is false, the two new rows will + # be green (because the row after the insertion point was green). + # Corresponds to the JSON property `inheritFromBefore` + # @return [Boolean] + attr_accessor :inherit_from_before + alias_method :inherit_from_before?, :inherit_from_before + + # A range along a single dimension on a sheet. + # All indexes are zero-based. + # Indexes are half open: the start index is inclusive + # and the end index is exclusive. + # Missing indexes indicate the range is unbounded on that side. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::DimensionRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inherit_from_before = args[:inherit_from_before] if args.key?(:inherit_from_before) + @range = args[:range] if args.key?(:range) + end + end + + # Deletes the embedded object with the given ID. + class DeleteEmbeddedObjectRequest + include Google::Apis::Core::Hashable + + # The ID of the embedded object to delete. + # Corresponds to the JSON property `objectId` + # @return [Fixnum] + attr_accessor :object_id_prop + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + end + end + + # A banded (alternating colors) range in a sheet. + class BandedRange + include Google::Apis::Core::Hashable + + # The id of the banded range. + # Corresponds to the JSON property `bandedRangeId` + # @return [Fixnum] + attr_accessor :banded_range_id + + # Properties referring a single dimension (either row or column). If both + # BandedRange.row_properties and BandedRange.column_properties are + # set, the fill colors are applied to cells according to the following rules: + # * header_color and footer_color take priority over band colors. + # * first_band_color takes priority over second_band_color. + # * row_properties takes priority over column_properties. + # For example, the first row color takes priority over the first column + # color, but the first column color takes priority over the second row color. + # Similarly, the row header takes priority over the column header in the + # top left cell, but the column header takes priority over the first row + # color if the row header is not set. + # Corresponds to the JSON property `rowProperties` + # @return [Google::Apis::SheetsV4::BandingProperties] + attr_accessor :row_properties + + # Properties referring a single dimension (either row or column). If both + # BandedRange.row_properties and BandedRange.column_properties are + # set, the fill colors are applied to cells according to the following rules: + # * header_color and footer_color take priority over band colors. + # * first_band_color takes priority over second_band_color. + # * row_properties takes priority over column_properties. + # For example, the first row color takes priority over the first column + # color, but the first column color takes priority over the second row color. + # Similarly, the row header takes priority over the column header in the + # top left cell, but the column header takes priority over the first row + # color if the row header is not set. + # Corresponds to the JSON property `columnProperties` + # @return [Google::Apis::SheetsV4::BandingProperties] + attr_accessor :column_properties + + # A range on a sheet. + # All indexes are zero-based. + # Indexes are half open, e.g the start index is inclusive + # and the end index is exclusive -- [start_index, end_index). + # Missing indexes indicate the range is unbounded on that side. + # For example, if `"Sheet1"` is sheet ID 0, then: + # `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, + # start_column_index: 0, end_column_index: 1` + # `Sheet1!A3:B4 == sheet_id: 0, + # start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` + # `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, + # start_column_index: 0, end_column_index: 2` + # `Sheet1 == sheet_id:0` + # The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. + # Empty ranges are typically not meaningful and are usually rendered in the + # UI as `#REF!`. + # Corresponds to the JSON property `range` + # @return [Google::Apis::SheetsV4::GridRange] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @banded_range_id = args[:banded_range_id] if args.key?(:banded_range_id) + @row_properties = args[:row_properties] if args.key?(:row_properties) + @column_properties = args[:column_properties] if args.key?(:column_properties) + @range = args[:range] if args.key?(:range) + end + end + + # The result of deleting a conditional format rule. + class DeleteConditionalFormatRuleResponse + include Google::Apis::Core::Hashable + + # A rule describing a conditional format. + # Corresponds to the JSON property `rule` + # @return [Google::Apis::SheetsV4::ConditionalFormatRule] + attr_accessor :rule + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rule = args[:rule] if args.key?(:rule) end end end diff --git a/generated/google/apis/sheets_v4/representations.rb b/generated/google/apis/sheets_v4/representations.rb index 506f38ec5..5f39c7580 100644 --- a/generated/google/apis/sheets_v4/representations.rb +++ b/generated/google/apis/sheets_v4/representations.rb @@ -22,145 +22,7 @@ module Google module Apis module SheetsV4 - class UpdateValuesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PivotValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ErrorValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CopySheetToAnotherSpreadsheetRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PivotGroupSortValueBucket - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EmbeddedObjectPosition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteProtectedRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AutoFillRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GradientRule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetBasicFilterRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ClearValuesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InterpolationPoint - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FindReplaceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteEmbeddedObjectRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteSheetRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DuplicateFilterViewRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateConditionalFormatRuleResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ConditionValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DuplicateSheetRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExtendedValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddChartRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Spreadsheet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BatchClearValuesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BandedRange + class AddNamedRangeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -172,7 +34,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class TextFormat + class Padding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MergeCellsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -184,301 +52,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class AddFilterViewResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SpreadsheetProperties - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OverlayPosition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepeatCellRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddChartResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InsertDimensionRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateSpreadsheetPropertiesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BatchUpdateValuesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ProtectedRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DimensionProperties - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DimensionRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class NamedRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CutPasteRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BasicChartSeries - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Borders - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AutoResizeDimensionsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateBordersRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CellFormat - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ClearValuesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteConditionalFormatRuleRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteNamedRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddBandingResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ChartData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BatchGetValuesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateBandingRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Color - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PivotGroup - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PivotTable - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ChartSourceRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AppendCellsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ValueRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddBandingRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Response - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InsertRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EmbeddedChart - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TextFormatRun - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddNamedRangeResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RowData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GridData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Border - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateNamedRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FindReplaceRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddSheetRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateCellsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteConditionalFormatRuleResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GridCoordinate - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateSheetPropertiesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UnmergeCellsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GridProperties + class PivotGroupValueMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -490,37 +64,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class SortSpec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Sheet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BooleanRule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FilterCriteria - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PivotGroupValueMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Editors + class ClearValuesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -532,121 +76,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class DataValidationRule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BasicChartDomain - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PasteDataRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AppendDimensionRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddNamedRangeRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateEmbeddedObjectPositionRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PieChartSpec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateFilterViewRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ConditionalFormatRule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CopyPasteRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Request - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BooleanCondition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GridRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BasicChartSpec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetDataValidationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CellData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BatchUpdateSpreadsheetRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BasicChartAxis - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Padding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteDimensionRequest + class TextFormat class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -658,6 +88,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GridCoordinate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DeleteFilterViewRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -670,37 +106,31 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class SortRangeRequest + class UpdateNamedRangeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class MergeCellsRequest + class UpdateValuesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class AddProtectedRangeRequest + class SpreadsheetProperties class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class BatchClearValuesRequest + class CellData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class DuplicateFilterViewResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DuplicateSheetResponse + class UnmergeCellsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -712,43 +142,37 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ClearBasicFilterRequest + class AddProtectedRangeResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class BatchUpdateSpreadsheetResponse + class BooleanCondition class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class DeleteBandingRequest + class DeleteProtectedRangeRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class AppendValuesResponse + class BasicChartDomain class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class MoveDimensionRequest + class DimensionRange class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class PivotFilterCriteria - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AddFilterViewRequest + class Response class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -760,13 +184,217 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ChartSpec + class FilterView class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class NumberFormat + class SortRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddBandingResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextFormatRun + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateFilterViewRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateConditionalFormatRuleResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FilterCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteDimensionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotTable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DataValidationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateSpreadsheetPropertiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChartSourceRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateValuesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClearBasicFilterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchClearValuesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConditionalFormatRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateBordersRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotFilterCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Borders + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EmbeddedChart + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Color + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddSheetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddProtectedRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ValueRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FindReplaceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppendValuesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CellFormat + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MoveDimensionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BasicChartAxis + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotGroupSortValueBucket + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EmbeddedObjectPosition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterpolationPoint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ErrorValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DuplicateFilterViewRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateSpreadsheetRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -778,7 +406,37 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class UpdateDimensionPropertiesRequest + class ClearValuesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProtectedRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteConditionalFormatRuleRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InsertRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChartSpec class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -790,19 +448,79 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class FilterView + class ConditionValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class BandingProperties + class PasteDataRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class AddProtectedRangeResponse + class FindReplaceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SortSpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CopySheetToAnotherSpreadsheetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NumberFormat + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchClearValuesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateDimensionPropertiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Editors + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Spreadsheet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GridData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteBandingRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -814,63 +532,512 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DuplicateSheetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddFilterViewResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DuplicateSheetResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Border + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddNamedRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddChartResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddBandingRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppendCellsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RowData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BasicChartSeries + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NamedRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepeatCellRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BasicChartSpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateEmbeddedObjectPositionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetBasicFilterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AutoResizeDimensionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DuplicateFilterViewResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BandingProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GridRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteSheetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateBandingRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChartData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Sheet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CopyPasteRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateCellsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExtendedValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateSpreadsheetResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GradientRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CutPasteRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OverlayPosition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AutoFillRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PieChartSpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateSheetPropertiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BooleanRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AppendDimensionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddFilterViewRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GridProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteNamedRangeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddChartRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetDataValidationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Request + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchGetValuesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InsertDimensionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteEmbeddedObjectRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BandedRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteConditionalFormatRuleResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddNamedRangeResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation + + end + end + + class UpdateProtectedRangeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation + + property :fields, as: 'fields' + end + end + + class Padding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :right, as: 'right' + property :left, as: 'left' + property :top, as: 'top' + property :bottom, as: 'bottom' + end + end + + class MergeCellsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :merge_type, as: 'mergeType' + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + end + end + + class AddSheetResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation + + end + end + + class PivotGroupValueMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + + property :collapsed, as: 'collapsed' + end + end + + class UpdateEmbeddedObjectPositionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :position, as: 'position', class: Google::Apis::SheetsV4::EmbeddedObjectPosition, decorator: Google::Apis::SheetsV4::EmbeddedObjectPosition::Representation + + end + end + + class ClearValuesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :spreadsheet_id, as: 'spreadsheetId' + property :cleared_range, as: 'clearedRange' + end + end + + class UpdateConditionalFormatRuleRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + property :rule, as: 'rule', class: Google::Apis::SheetsV4::ConditionalFormatRule, decorator: Google::Apis::SheetsV4::ConditionalFormatRule::Representation + + property :index, as: 'index' + property :new_index, as: 'newIndex' + end + end + + class TextFormat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bold, as: 'bold' + property :italic, as: 'italic' + property :foreground_color, as: 'foregroundColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :font_family, as: 'fontFamily' + property :strikethrough, as: 'strikethrough' + property :font_size, as: 'fontSize' + property :underline, as: 'underline' + end + end + + class UpdateChartSpecRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :chart_id, as: 'chartId' + property :spec, as: 'spec', class: Google::Apis::SheetsV4::ChartSpec, decorator: Google::Apis::SheetsV4::ChartSpec::Representation + + end + end + + class GridCoordinate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + property :row_index, as: 'rowIndex' + property :column_index, as: 'columnIndex' + end + end + + class DeleteFilterViewRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter_id, as: 'filterId' + end + end + + class BatchUpdateValuesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :total_updated_sheets, as: 'totalUpdatedSheets' + property :total_updated_columns, as: 'totalUpdatedColumns' + collection :responses, as: 'responses', class: Google::Apis::SheetsV4::UpdateValuesResponse, decorator: Google::Apis::SheetsV4::UpdateValuesResponse::Representation + + property :total_updated_cells, as: 'totalUpdatedCells' + property :spreadsheet_id, as: 'spreadsheetId' + property :total_updated_rows, as: 'totalUpdatedRows' + end + end + + class UpdateNamedRangeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fields, as: 'fields' + property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation + + end + end + class UpdateValuesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :updated_columns, as: 'updatedColumns' + property :updated_cells, as: 'updatedCells' property :updated_data, as: 'updatedData', class: Google::Apis::SheetsV4::ValueRange, decorator: Google::Apis::SheetsV4::ValueRange::Representation - property :updated_rows, as: 'updatedRows' - property :updated_columns, as: 'updatedColumns' - property :spreadsheet_id, as: 'spreadsheetId' property :updated_range, as: 'updatedRange' - property :updated_cells, as: 'updatedCells' + property :spreadsheet_id, as: 'spreadsheetId' + property :updated_rows, as: 'updatedRows' end end - class PivotValue + class SpreadsheetProperties # @private class Representation < Google::Apis::Core::JsonRepresentation - property :source_column_offset, as: 'sourceColumnOffset' - property :name, as: 'name' - property :formula, as: 'formula' - property :summarize_function, as: 'summarizeFunction' + property :time_zone, as: 'timeZone' + property :auto_recalc, as: 'autoRecalc' + property :locale, as: 'locale' + property :title, as: 'title' + property :default_format, as: 'defaultFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation + end end - class ErrorValue + class CellData # @private class Representation < Google::Apis::Core::JsonRepresentation - property :message, as: 'message' + property :hyperlink, as: 'hyperlink' + property :effective_format, as: 'effectiveFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation + + property :note, as: 'note' + property :formatted_value, as: 'formattedValue' + property :user_entered_value, as: 'userEnteredValue', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + + property :data_validation, as: 'dataValidation', class: Google::Apis::SheetsV4::DataValidationRule, decorator: Google::Apis::SheetsV4::DataValidationRule::Representation + + property :user_entered_format, as: 'userEnteredFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation + + property :pivot_table, as: 'pivotTable', class: Google::Apis::SheetsV4::PivotTable, decorator: Google::Apis::SheetsV4::PivotTable::Representation + + collection :text_format_runs, as: 'textFormatRuns', class: Google::Apis::SheetsV4::TextFormatRun, decorator: Google::Apis::SheetsV4::TextFormatRun::Representation + + property :effective_value, as: 'effectiveValue', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + + end + end + + class UnmergeCellsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + end + end + + class TextToColumnsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :delimiter, as: 'delimiter' + property :delimiter_type, as: 'delimiterType' + end + end + + class AddProtectedRangeResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation + + end + end + + class BooleanCondition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values', class: Google::Apis::SheetsV4::ConditionValue, decorator: Google::Apis::SheetsV4::ConditionValue::Representation + property :type, as: 'type' end end - class CopySheetToAnotherSpreadsheetRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :destination_spreadsheet_id, as: 'destinationSpreadsheetId' - end - end - - class PivotGroupSortValueBucket - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :buckets, as: 'buckets', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation - - property :values_index, as: 'valuesIndex' - end - end - - class EmbeddedObjectPosition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_sheet, as: 'newSheet' - property :sheet_id, as: 'sheetId' - property :overlay_position, as: 'overlayPosition', class: Google::Apis::SheetsV4::OverlayPosition, decorator: Google::Apis::SheetsV4::OverlayPosition::Representation - - end - end - class DeleteProtectedRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -878,82 +1045,111 @@ module Google end end - class AutoFillRequest + class BasicChartDomain # @private class Representation < Google::Apis::Core::JsonRepresentation - property :use_alternate_series, as: 'useAlternateSeries' - property :source_and_destination, as: 'sourceAndDestination', class: Google::Apis::SheetsV4::SourceAndDestination, decorator: Google::Apis::SheetsV4::SourceAndDestination::Representation - - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + property :domain, as: 'domain', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation end end - class GradientRule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :minpoint, as: 'minpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation - - property :maxpoint, as: 'maxpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation - - property :midpoint, as: 'midpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation - - end - end - - class SetBasicFilterRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter, as: 'filter', class: Google::Apis::SheetsV4::BasicFilter, decorator: Google::Apis::SheetsV4::BasicFilter::Representation - - end - end - - class ClearValuesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class InterpolationPoint - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :color, as: 'color', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :type, as: 'type' - property :value, as: 'value' - end - end - - class FindReplaceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :values_changed, as: 'valuesChanged' - property :occurrences_changed, as: 'occurrencesChanged' - property :rows_changed, as: 'rowsChanged' - property :sheets_changed, as: 'sheetsChanged' - property :formulas_changed, as: 'formulasChanged' - end - end - - class DeleteEmbeddedObjectRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :object_id_prop, as: 'objectId' - end - end - - class DeleteSheetRequest + class DimensionRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :sheet_id, as: 'sheetId' + property :end_index, as: 'endIndex' + property :start_index, as: 'startIndex' + property :dimension, as: 'dimension' end end - class DuplicateFilterViewRequest + class Response # @private class Representation < Google::Apis::Core::JsonRepresentation - property :filter_id, as: 'filterId' + property :update_embedded_object_position, as: 'updateEmbeddedObjectPosition', class: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse, decorator: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse::Representation + + property :add_filter_view, as: 'addFilterView', class: Google::Apis::SheetsV4::AddFilterViewResponse, decorator: Google::Apis::SheetsV4::AddFilterViewResponse::Representation + + property :add_sheet, as: 'addSheet', class: Google::Apis::SheetsV4::AddSheetResponse, decorator: Google::Apis::SheetsV4::AddSheetResponse::Representation + + property :find_replace, as: 'findReplace', class: Google::Apis::SheetsV4::FindReplaceResponse, decorator: Google::Apis::SheetsV4::FindReplaceResponse::Representation + + property :add_protected_range, as: 'addProtectedRange', class: Google::Apis::SheetsV4::AddProtectedRangeResponse, decorator: Google::Apis::SheetsV4::AddProtectedRangeResponse::Representation + + property :update_conditional_format_rule, as: 'updateConditionalFormatRule', class: Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse, decorator: Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse::Representation + + property :add_chart, as: 'addChart', class: Google::Apis::SheetsV4::AddChartResponse, decorator: Google::Apis::SheetsV4::AddChartResponse::Representation + + property :delete_conditional_format_rule, as: 'deleteConditionalFormatRule', class: Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse, decorator: Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse::Representation + + property :add_banding, as: 'addBanding', class: Google::Apis::SheetsV4::AddBandingResponse, decorator: Google::Apis::SheetsV4::AddBandingResponse::Representation + + property :duplicate_sheet, as: 'duplicateSheet', class: Google::Apis::SheetsV4::DuplicateSheetResponse, decorator: Google::Apis::SheetsV4::DuplicateSheetResponse::Representation + + property :duplicate_filter_view, as: 'duplicateFilterView', class: Google::Apis::SheetsV4::DuplicateFilterViewResponse, decorator: Google::Apis::SheetsV4::DuplicateFilterViewResponse::Representation + + property :add_named_range, as: 'addNamedRange', class: Google::Apis::SheetsV4::AddNamedRangeResponse, decorator: Google::Apis::SheetsV4::AddNamedRangeResponse::Representation + + end + end + + class AddConditionalFormatRuleRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :rule, as: 'rule', class: Google::Apis::SheetsV4::ConditionalFormatRule, decorator: Google::Apis::SheetsV4::ConditionalFormatRule::Representation + + property :index, as: 'index' + end + end + + class FilterView + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :title, as: 'title' + property :named_range_id, as: 'namedRangeId' + collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation + + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::FilterCriteria, decorator: Google::Apis::SheetsV4::FilterCriteria::Representation + + property :filter_view_id, as: 'filterViewId' + end + end + + class SortRangeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation + + end + end + + class AddBandingResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation + + end + end + + class TextFormatRun + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :start_index, as: 'startIndex' + property :format, as: 'format', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation + + end + end + + class UpdateFilterViewRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation + + property :fields, as: 'fields' end end @@ -969,170 +1165,51 @@ module Google end end - class ConditionValue + class FilterCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation - property :relative_date, as: 'relativeDate' - property :user_entered_value, as: 'userEnteredValue' + property :condition, as: 'condition', class: Google::Apis::SheetsV4::BooleanCondition, decorator: Google::Apis::SheetsV4::BooleanCondition::Representation + + collection :hidden_values, as: 'hiddenValues' end end - class DuplicateSheetRequest + class DeleteDimensionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :new_sheet_name, as: 'newSheetName' - property :source_sheet_id, as: 'sourceSheetId' - property :new_sheet_id, as: 'newSheetId' - property :insert_sheet_index, as: 'insertSheetIndex' - end - end - - class ExtendedValue - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :error_value, as: 'errorValue', class: Google::Apis::SheetsV4::ErrorValue, decorator: Google::Apis::SheetsV4::ErrorValue::Representation - - property :string_value, as: 'stringValue' - property :bool_value, as: 'boolValue' - property :formula_value, as: 'formulaValue' - property :number_value, as: 'numberValue' - end - end - - class AddChartRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :chart, as: 'chart', class: Google::Apis::SheetsV4::EmbeddedChart, decorator: Google::Apis::SheetsV4::EmbeddedChart::Representation - - end - end - - class Spreadsheet - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :properties, as: 'properties', class: Google::Apis::SheetsV4::SpreadsheetProperties, decorator: Google::Apis::SheetsV4::SpreadsheetProperties::Representation - - property :spreadsheet_id, as: 'spreadsheetId' - collection :sheets, as: 'sheets', class: Google::Apis::SheetsV4::Sheet, decorator: Google::Apis::SheetsV4::Sheet::Representation - - collection :named_ranges, as: 'namedRanges', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation - - property :spreadsheet_url, as: 'spreadsheetUrl' - end - end - - class BatchClearValuesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :cleared_ranges, as: 'clearedRanges' - property :spreadsheet_id, as: 'spreadsheetId' - end - end - - class BandedRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :banded_range_id, as: 'bandedRangeId' - property :row_properties, as: 'rowProperties', class: Google::Apis::SheetsV4::BandingProperties, decorator: Google::Apis::SheetsV4::BandingProperties::Representation - - property :column_properties, as: 'columnProperties', class: Google::Apis::SheetsV4::BandingProperties, decorator: Google::Apis::SheetsV4::BandingProperties::Representation - - end - end - - class UpdateProtectedRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation - - property :fields, as: 'fields' - end - end - - class TextFormat - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :font_family, as: 'fontFamily' - property :strikethrough, as: 'strikethrough' - property :italic, as: 'italic' - property :font_size, as: 'fontSize' - property :underline, as: 'underline' - property :bold, as: 'bold' - property :foreground_color, as: 'foregroundColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - end - end - - class AddSheetResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation - - end - end - - class AddFilterViewResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation - - end - end - - class SpreadsheetProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :locale, as: 'locale' - property :auto_recalc, as: 'autoRecalc' - property :default_format, as: 'defaultFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation - - property :title, as: 'title' - property :time_zone, as: 'timeZone' - end - end - - class OverlayPosition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :width_pixels, as: 'widthPixels' - property :offset_x_pixels, as: 'offsetXPixels' - property :anchor_cell, as: 'anchorCell', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation - - property :offset_y_pixels, as: 'offsetYPixels' - property :height_pixels, as: 'heightPixels' - end - end - - class RepeatCellRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :fields, as: 'fields' - property :cell, as: 'cell', class: Google::Apis::SheetsV4::CellData, decorator: Google::Apis::SheetsV4::CellData::Representation - - end - end - - class AddChartResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :chart, as: 'chart', class: Google::Apis::SheetsV4::EmbeddedChart, decorator: Google::Apis::SheetsV4::EmbeddedChart::Representation - - end - end - - class InsertDimensionRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inherit_from_before, as: 'inheritFromBefore' property :range, as: 'range', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation end end + class PivotTable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value_layout, as: 'valueLayout' + collection :columns, as: 'columns', class: Google::Apis::SheetsV4::PivotGroup, decorator: Google::Apis::SheetsV4::PivotGroup::Representation + + property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + collection :rows, as: 'rows', class: Google::Apis::SheetsV4::PivotGroup, decorator: Google::Apis::SheetsV4::PivotGroup::Representation + + collection :values, as: 'values', class: Google::Apis::SheetsV4::PivotValue, decorator: Google::Apis::SheetsV4::PivotValue::Representation + + hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::PivotFilterCriteria, decorator: Google::Apis::SheetsV4::PivotFilterCriteria::Representation + + end + end + + class DataValidationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::SheetsV4::BooleanCondition, decorator: Google::Apis::SheetsV4::BooleanCondition::Representation + + property :input_message, as: 'inputMessage' + property :show_custom_ui, as: 'showCustomUi' + property :strict, as: 'strict' + end + end + class UpdateSpreadsheetPropertiesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1142,245 +1219,6 @@ module Google end end - class BatchUpdateValuesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :value_input_option, as: 'valueInputOption' - collection :data, as: 'data', class: Google::Apis::SheetsV4::ValueRange, decorator: Google::Apis::SheetsV4::ValueRange::Representation - - property :response_date_time_render_option, as: 'responseDateTimeRenderOption' - property :response_value_render_option, as: 'responseValueRenderOption' - property :include_values_in_response, as: 'includeValuesInResponse' - end - end - - class ProtectedRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :requesting_user_can_edit, as: 'requestingUserCanEdit' - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :editors, as: 'editors', class: Google::Apis::SheetsV4::Editors, decorator: Google::Apis::SheetsV4::Editors::Representation - - property :description, as: 'description' - collection :unprotected_ranges, as: 'unprotectedRanges', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :named_range_id, as: 'namedRangeId' - property :protected_range_id, as: 'protectedRangeId' - property :warning_only, as: 'warningOnly' - end - end - - class DimensionProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pixel_size, as: 'pixelSize' - property :hidden_by_filter, as: 'hiddenByFilter' - property :hidden_by_user, as: 'hiddenByUser' - end - end - - class DimensionRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sheet_id, as: 'sheetId' - property :dimension, as: 'dimension' - property :start_index, as: 'startIndex' - property :end_index, as: 'endIndex' - end - end - - class NamedRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :named_range_id, as: 'namedRangeId' - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - end - end - - class CutPasteRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :destination, as: 'destination', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation - - property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :paste_type, as: 'pasteType' - end - end - - class BasicChartSeries - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :series, as: 'series', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation - - property :type, as: 'type' - property :target_axis, as: 'targetAxis' - end - end - - class Borders - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :right, as: 'right', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :bottom, as: 'bottom', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :top, as: 'top', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :left, as: 'left', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - end - end - - class AutoResizeDimensionsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :dimensions, as: 'dimensions', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation - - end - end - - class UpdateBordersRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bottom, as: 'bottom', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :inner_vertical, as: 'innerVertical', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :right, as: 'right', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :inner_horizontal, as: 'innerHorizontal', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :top, as: 'top', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - property :left, as: 'left', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - - end - end - - class CellFormat - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :vertical_alignment, as: 'verticalAlignment' - property :padding, as: 'padding', class: Google::Apis::SheetsV4::Padding, decorator: Google::Apis::SheetsV4::Padding::Representation - - property :borders, as: 'borders', class: Google::Apis::SheetsV4::Borders, decorator: Google::Apis::SheetsV4::Borders::Representation - - property :text_direction, as: 'textDirection' - property :wrap_strategy, as: 'wrapStrategy' - property :number_format, as: 'numberFormat', class: Google::Apis::SheetsV4::NumberFormat, decorator: Google::Apis::SheetsV4::NumberFormat::Representation - - property :horizontal_alignment, as: 'horizontalAlignment' - property :hyperlink_display_type, as: 'hyperlinkDisplayType' - property :text_format, as: 'textFormat', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation - - property :background_color, as: 'backgroundColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - end - end - - class ClearValuesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :spreadsheet_id, as: 'spreadsheetId' - property :cleared_range, as: 'clearedRange' - end - end - - class DeleteConditionalFormatRuleRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :index, as: 'index' - property :sheet_id, as: 'sheetId' - end - end - - class DeleteNamedRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :named_range_id, as: 'namedRangeId' - end - end - - class AddBandingResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation - - end - end - - class ChartData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :source_range, as: 'sourceRange', class: Google::Apis::SheetsV4::ChartSourceRange, decorator: Google::Apis::SheetsV4::ChartSourceRange::Representation - - end - end - - class BatchGetValuesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :spreadsheet_id, as: 'spreadsheetId' - collection :value_ranges, as: 'valueRanges', class: Google::Apis::SheetsV4::ValueRange, decorator: Google::Apis::SheetsV4::ValueRange::Representation - - end - end - - class UpdateBandingRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fields, as: 'fields' - property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation - - end - end - - class Color - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :red, as: 'red' - property :green, as: 'green' - property :blue, as: 'blue' - property :alpha, as: 'alpha' - end - end - - class PivotGroup - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sort_order, as: 'sortOrder' - property :value_bucket, as: 'valueBucket', class: Google::Apis::SheetsV4::PivotGroupSortValueBucket, decorator: Google::Apis::SheetsV4::PivotGroupSortValueBucket::Representation - - property :source_column_offset, as: 'sourceColumnOffset' - property :show_totals, as: 'showTotals' - collection :value_metadata, as: 'valueMetadata', class: Google::Apis::SheetsV4::PivotGroupValueMetadata, decorator: Google::Apis::SheetsV4::PivotGroupValueMetadata::Representation - - end - end - - class PivotTable - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :rows, as: 'rows', class: Google::Apis::SheetsV4::PivotGroup, decorator: Google::Apis::SheetsV4::PivotGroup::Representation - - property :value_layout, as: 'valueLayout' - collection :columns, as: 'columns', class: Google::Apis::SheetsV4::PivotGroup, decorator: Google::Apis::SheetsV4::PivotGroup::Representation - - collection :values, as: 'values', class: Google::Apis::SheetsV4::PivotValue, decorator: Google::Apis::SheetsV4::PivotValue::Representation - - property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::PivotFilterCriteria, decorator: Google::Apis::SheetsV4::PivotFilterCriteria::Representation - - end - end - class ChartSourceRange # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1389,73 +1227,83 @@ module Google end end - class AppendCellsRequest + class BatchUpdateValuesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :rows, as: 'rows', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation + property :value_input_option, as: 'valueInputOption' + collection :data, as: 'data', class: Google::Apis::SheetsV4::ValueRange, decorator: Google::Apis::SheetsV4::ValueRange::Representation - property :fields, as: 'fields' + property :response_value_render_option, as: 'responseValueRenderOption' + property :response_date_time_render_option, as: 'responseDateTimeRenderOption' + property :include_values_in_response, as: 'includeValuesInResponse' + end + end + + class ClearBasicFilterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation property :sheet_id, as: 'sheetId' end end - class ValueRange + class BatchClearValuesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :major_dimension, as: 'majorDimension' - collection :values, as: 'values', :class => Array do - include Representable::JSON::Collection - items - end - - property :range, as: 'range' + property :spreadsheet_id, as: 'spreadsheetId' + collection :cleared_ranges, as: 'clearedRanges' end end - class AddBandingRequest + class ConditionalFormatRule # @private class Representation < Google::Apis::Core::JsonRepresentation - property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation + property :gradient_rule, as: 'gradientRule', class: Google::Apis::SheetsV4::GradientRule, decorator: Google::Apis::SheetsV4::GradientRule::Representation + + property :boolean_rule, as: 'booleanRule', class: Google::Apis::SheetsV4::BooleanRule, decorator: Google::Apis::SheetsV4::BooleanRule::Representation + + collection :ranges, as: 'ranges', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation end end - class Response + class UpdateBordersRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :add_filter_view, as: 'addFilterView', class: Google::Apis::SheetsV4::AddFilterViewResponse, decorator: Google::Apis::SheetsV4::AddFilterViewResponse::Representation + property :right, as: 'right', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - property :add_banding, as: 'addBanding', class: Google::Apis::SheetsV4::AddBandingResponse, decorator: Google::Apis::SheetsV4::AddBandingResponse::Representation + property :inner_vertical, as: 'innerVertical', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - property :add_protected_range, as: 'addProtectedRange', class: Google::Apis::SheetsV4::AddProtectedRangeResponse, decorator: Google::Apis::SheetsV4::AddProtectedRangeResponse::Representation + property :top, as: 'top', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - property :duplicate_sheet, as: 'duplicateSheet', class: Google::Apis::SheetsV4::DuplicateSheetResponse, decorator: Google::Apis::SheetsV4::DuplicateSheetResponse::Representation + property :inner_horizontal, as: 'innerHorizontal', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation - property :update_embedded_object_position, as: 'updateEmbeddedObjectPosition', class: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse, decorator: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionResponse::Representation - - property :delete_conditional_format_rule, as: 'deleteConditionalFormatRule', class: Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse, decorator: Google::Apis::SheetsV4::DeleteConditionalFormatRuleResponse::Representation - - property :duplicate_filter_view, as: 'duplicateFilterView', class: Google::Apis::SheetsV4::DuplicateFilterViewResponse, decorator: Google::Apis::SheetsV4::DuplicateFilterViewResponse::Representation - - property :add_chart, as: 'addChart', class: Google::Apis::SheetsV4::AddChartResponse, decorator: Google::Apis::SheetsV4::AddChartResponse::Representation - - property :find_replace, as: 'findReplace', class: Google::Apis::SheetsV4::FindReplaceResponse, decorator: Google::Apis::SheetsV4::FindReplaceResponse::Representation - - property :add_sheet, as: 'addSheet', class: Google::Apis::SheetsV4::AddSheetResponse, decorator: Google::Apis::SheetsV4::AddSheetResponse::Representation - - property :update_conditional_format_rule, as: 'updateConditionalFormatRule', class: Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse, decorator: Google::Apis::SheetsV4::UpdateConditionalFormatRuleResponse::Representation - - property :add_named_range, as: 'addNamedRange', class: Google::Apis::SheetsV4::AddNamedRangeResponse, decorator: Google::Apis::SheetsV4::AddNamedRangeResponse::Representation - - end - end - - class InsertRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :shift_dimension, as: 'shiftDimension' property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + property :bottom, as: 'bottom', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + + property :left, as: 'left', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + + end + end + + class PivotFilterCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :visible_values, as: 'visibleValues' + end + end + + class Borders + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :left, as: 'left', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + + property :right, as: 'right', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + + property :top, as: 'top', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + + property :bottom, as: 'bottom', class: Google::Apis::SheetsV4::Border, decorator: Google::Apis::SheetsV4::Border::Representation + end end @@ -1470,77 +1318,13 @@ module Google end end - class TextFormatRun + class Color # @private class Representation < Google::Apis::Core::JsonRepresentation - property :start_index, as: 'startIndex' - property :format, as: 'format', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation - - end - end - - class AddNamedRangeResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation - - end - end - - class RowData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :values, as: 'values', class: Google::Apis::SheetsV4::CellData, decorator: Google::Apis::SheetsV4::CellData::Representation - - end - end - - class GridData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :row_data, as: 'rowData', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation - - property :start_row, as: 'startRow' - collection :column_metadata, as: 'columnMetadata', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation - - property :start_column, as: 'startColumn' - collection :row_metadata, as: 'rowMetadata', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation - - end - end - - class Border - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :color, as: 'color', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :width, as: 'width' - property :style, as: 'style' - end - end - - class UpdateNamedRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation - - property :fields, as: 'fields' - end - end - - class FindReplaceRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :match_entire_cell, as: 'matchEntireCell' - property :search_by_regex, as: 'searchByRegex' - property :find, as: 'find' - property :replacement, as: 'replacement' - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :sheet_id, as: 'sheetId' - property :all_sheets, as: 'allSheets' - property :match_case, as: 'matchCase' - property :include_formulas, as: 'includeFormulas' + property :green, as: 'green' + property :blue, as: 'blue' + property :red, as: 'red' + property :alpha, as: 'alpha' end end @@ -1552,24 +1336,196 @@ module Google end end - class UpdateCellsRequest + class AddProtectedRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :rows, as: 'rows', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation + property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation - property :fields, as: 'fields' - property :start, as: 'start', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation + end + end + class ValueRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values', :class => Array do + include Representable::JSON::Collection + items + end + + property :range, as: 'range' + property :major_dimension, as: 'majorDimension' + end + end + + class FindReplaceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :values_changed, as: 'valuesChanged' + property :rows_changed, as: 'rowsChanged' + property :occurrences_changed, as: 'occurrencesChanged' + property :formulas_changed, as: 'formulasChanged' + property :sheets_changed, as: 'sheetsChanged' + end + end + + class AppendValuesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :spreadsheet_id, as: 'spreadsheetId' + property :table_range, as: 'tableRange' + property :updates, as: 'updates', class: Google::Apis::SheetsV4::UpdateValuesResponse, decorator: Google::Apis::SheetsV4::UpdateValuesResponse::Representation + + end + end + + class CellFormat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :horizontal_alignment, as: 'horizontalAlignment' + property :hyperlink_display_type, as: 'hyperlinkDisplayType' + property :borders, as: 'borders', class: Google::Apis::SheetsV4::Borders, decorator: Google::Apis::SheetsV4::Borders::Representation + + property :text_direction, as: 'textDirection' + property :text_format, as: 'textFormat', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation + + property :padding, as: 'padding', class: Google::Apis::SheetsV4::Padding, decorator: Google::Apis::SheetsV4::Padding::Representation + + property :number_format, as: 'numberFormat', class: Google::Apis::SheetsV4::NumberFormat, decorator: Google::Apis::SheetsV4::NumberFormat::Representation + + property :wrap_strategy, as: 'wrapStrategy' + property :background_color, as: 'backgroundColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :vertical_alignment, as: 'verticalAlignment' + end + end + + class MoveDimensionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source, as: 'source', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation + + property :destination_index, as: 'destinationIndex' + end + end + + class BasicChartAxis + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :position, as: 'position' + property :title, as: 'title' + property :format, as: 'format', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation + + end + end + + class PivotGroupSortValueBucket + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buckets, as: 'buckets', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + + property :values_index, as: 'valuesIndex' + end + end + + class DimensionProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hidden_by_user, as: 'hiddenByUser' + property :pixel_size, as: 'pixelSize' + property :hidden_by_filter, as: 'hiddenByFilter' + end + end + + class EmbeddedObjectPosition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + property :overlay_position, as: 'overlayPosition', class: Google::Apis::SheetsV4::OverlayPosition, decorator: Google::Apis::SheetsV4::OverlayPosition::Representation + + property :new_sheet, as: 'newSheet' + end + end + + class InterpolationPoint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value' + property :color, as: 'color', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :type, as: 'type' + end + end + + class ErrorValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + property :message, as: 'message' + end + end + + class DuplicateFilterViewRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter_id, as: 'filterId' + end + end + + class BatchUpdateSpreadsheetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :include_spreadsheet_in_response, as: 'includeSpreadsheetInResponse' + collection :requests, as: 'requests', class: Google::Apis::SheetsV4::Request, decorator: Google::Apis::SheetsV4::Request::Representation + + collection :response_ranges, as: 'responseRanges' + property :response_include_grid_data, as: 'responseIncludeGridData' + end + end + + class SheetProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :title, as: 'title' + property :index, as: 'index' + property :hidden, as: 'hidden' + property :grid_properties, as: 'gridProperties', class: Google::Apis::SheetsV4::GridProperties, decorator: Google::Apis::SheetsV4::GridProperties::Representation + + property :sheet_id, as: 'sheetId' + property :right_to_left, as: 'rightToLeft' + property :tab_color, as: 'tabColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :sheet_type, as: 'sheetType' + end + end + + class ClearValuesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ProtectedRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :unprotected_ranges, as: 'unprotectedRanges', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :description, as: 'description' + property :named_range_id, as: 'namedRangeId' + property :requesting_user_can_edit, as: 'requestingUserCanEdit' + property :editors, as: 'editors', class: Google::Apis::SheetsV4::Editors, decorator: Google::Apis::SheetsV4::Editors::Representation + + property :protected_range_id, as: 'protectedRangeId' + property :warning_only, as: 'warningOnly' property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation end end - class DeleteConditionalFormatRuleResponse + class DeleteConditionalFormatRuleRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :rule, as: 'rule', class: Google::Apis::SheetsV4::ConditionalFormatRule, decorator: Google::Apis::SheetsV4::ConditionalFormatRule::Representation - + property :sheet_id, as: 'sheetId' + property :index, as: 'index' end end @@ -1582,48 +1538,70 @@ module Google end end - class GridCoordinate - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sheet_id, as: 'sheetId' - property :row_index, as: 'rowIndex' - property :column_index, as: 'columnIndex' - end - end - - class UpdateSheetPropertiesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fields, as: 'fields' - property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation - - end - end - - class UnmergeCellsRequest + class InsertRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :shift_dimension, as: 'shiftDimension' property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation end end - class GridProperties + class ChartSpec # @private class Representation < Google::Apis::Core::JsonRepresentation - property :row_count, as: 'rowCount' - property :frozen_row_count, as: 'frozenRowCount' - property :hide_gridlines, as: 'hideGridlines' - property :column_count, as: 'columnCount' - property :frozen_column_count, as: 'frozenColumnCount' + property :hidden_dimension_strategy, as: 'hiddenDimensionStrategy' + property :basic_chart, as: 'basicChart', class: Google::Apis::SheetsV4::BasicChartSpec, decorator: Google::Apis::SheetsV4::BasicChartSpec::Representation + + property :title, as: 'title' + property :pie_chart, as: 'pieChart', class: Google::Apis::SheetsV4::PieChartSpec, decorator: Google::Apis::SheetsV4::PieChartSpec::Representation + end end - class UpdateEmbeddedObjectPositionResponse + class SourceAndDestination # @private class Representation < Google::Apis::Core::JsonRepresentation - property :position, as: 'position', class: Google::Apis::SheetsV4::EmbeddedObjectPosition, decorator: Google::Apis::SheetsV4::EmbeddedObjectPosition::Representation + property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + property :fill_length, as: 'fillLength' + property :dimension, as: 'dimension' + end + end + + class ConditionValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :relative_date, as: 'relativeDate' + property :user_entered_value, as: 'userEnteredValue' + end + end + + class PasteDataRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data, as: 'data' + property :coordinate, as: 'coordinate', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation + + property :delimiter, as: 'delimiter' + property :type, as: 'type' + property :html, as: 'html' + end + end + + class FindReplaceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :find, as: 'find' + property :replacement, as: 'replacement' + property :search_by_regex, as: 'searchByRegex' + property :sheet_id, as: 'sheetId' + property :all_sheets, as: 'allSheets' + property :match_case, as: 'matchCase' + property :include_formulas, as: 'includeFormulas' + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :match_entire_cell, as: 'matchEntireCell' end end @@ -1635,6 +1613,325 @@ module Google end end + class CopySheetToAnotherSpreadsheetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination_spreadsheet_id, as: 'destinationSpreadsheetId' + end + end + + class NumberFormat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pattern, as: 'pattern' + property :type, as: 'type' + end + end + + class BatchClearValuesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ranges, as: 'ranges' + end + end + + class UpdateDimensionPropertiesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fields, as: 'fields' + property :range, as: 'range', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation + + property :properties, as: 'properties', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation + + end + end + + class Editors + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :users, as: 'users' + collection :groups, as: 'groups' + property :domain_users_can_edit, as: 'domainUsersCanEdit' + end + end + + class Spreadsheet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :spreadsheet_id, as: 'spreadsheetId' + property :properties, as: 'properties', class: Google::Apis::SheetsV4::SpreadsheetProperties, decorator: Google::Apis::SheetsV4::SpreadsheetProperties::Representation + + property :spreadsheet_url, as: 'spreadsheetUrl' + collection :sheets, as: 'sheets', class: Google::Apis::SheetsV4::Sheet, decorator: Google::Apis::SheetsV4::Sheet::Representation + + collection :named_ranges, as: 'namedRanges', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation + + end + end + + class GridData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :column_metadata, as: 'columnMetadata', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation + + collection :row_data, as: 'rowData', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation + + property :start_row, as: 'startRow' + collection :row_metadata, as: 'rowMetadata', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation + + property :start_column, as: 'startColumn' + end + end + + class PivotValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :formula, as: 'formula' + property :source_column_offset, as: 'sourceColumnOffset' + property :summarize_function, as: 'summarizeFunction' + property :name, as: 'name' + end + end + + class DeleteBandingRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :banded_range_id, as: 'bandedRangeId' + end + end + + class BasicFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::FilterCriteria, decorator: Google::Apis::SheetsV4::FilterCriteria::Representation + + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation + + end + end + + class DuplicateSheetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source_sheet_id, as: 'sourceSheetId' + property :new_sheet_id, as: 'newSheetId' + property :insert_sheet_index, as: 'insertSheetIndex' + property :new_sheet_name, as: 'newSheetName' + end + end + + class AddFilterViewResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation + + end + end + + class DuplicateSheetResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation + + end + end + + class Border + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :style, as: 'style' + property :width, as: 'width' + property :color, as: 'color', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + end + end + + class AddNamedRangeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation + + end + end + + class AddChartResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :chart, as: 'chart', class: Google::Apis::SheetsV4::EmbeddedChart, decorator: Google::Apis::SheetsV4::EmbeddedChart::Representation + + end + end + + class AddBandingRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation + + end + end + + class AppendCellsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + collection :rows, as: 'rows', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation + + property :fields, as: 'fields' + end + end + + class RowData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values', class: Google::Apis::SheetsV4::CellData, decorator: Google::Apis::SheetsV4::CellData::Representation + + end + end + + class BasicChartSeries + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :series, as: 'series', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation + + property :target_axis, as: 'targetAxis' + property :type, as: 'type' + end + end + + class NamedRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :named_range_id, as: 'namedRangeId' + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :name, as: 'name' + end + end + + class RepeatCellRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cell, as: 'cell', class: Google::Apis::SheetsV4::CellData, decorator: Google::Apis::SheetsV4::CellData::Representation + + property :fields, as: 'fields' + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + end + end + + class BasicChartSpec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :chart_type, as: 'chartType' + collection :domains, as: 'domains', class: Google::Apis::SheetsV4::BasicChartDomain, decorator: Google::Apis::SheetsV4::BasicChartDomain::Representation + + property :header_count, as: 'headerCount' + collection :series, as: 'series', class: Google::Apis::SheetsV4::BasicChartSeries, decorator: Google::Apis::SheetsV4::BasicChartSeries::Representation + + property :legend_position, as: 'legendPosition' + collection :axis, as: 'axis', class: Google::Apis::SheetsV4::BasicChartAxis, decorator: Google::Apis::SheetsV4::BasicChartAxis::Representation + + end + end + + class UpdateEmbeddedObjectPositionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :new_position, as: 'newPosition', class: Google::Apis::SheetsV4::EmbeddedObjectPosition, decorator: Google::Apis::SheetsV4::EmbeddedObjectPosition::Representation + + property :object_id_prop, as: 'objectId' + property :fields, as: 'fields' + end + end + + class SetBasicFilterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter', class: Google::Apis::SheetsV4::BasicFilter, decorator: Google::Apis::SheetsV4::BasicFilter::Representation + + end + end + + class AutoResizeDimensionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimensions, as: 'dimensions', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation + + end + end + + class DuplicateFilterViewResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation + + end + end + + class BandingProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :footer_color, as: 'footerColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :header_color, as: 'headerColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :second_band_color, as: 'secondBandColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + property :first_band_color, as: 'firstBandColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation + + end + end + + class PivotGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sort_order, as: 'sortOrder' + property :source_column_offset, as: 'sourceColumnOffset' + property :show_totals, as: 'showTotals' + property :value_bucket, as: 'valueBucket', class: Google::Apis::SheetsV4::PivotGroupSortValueBucket, decorator: Google::Apis::SheetsV4::PivotGroupSortValueBucket::Representation + + collection :value_metadata, as: 'valueMetadata', class: Google::Apis::SheetsV4::PivotGroupValueMetadata, decorator: Google::Apis::SheetsV4::PivotGroupValueMetadata::Representation + + end + end + + class GridRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + property :start_column_index, as: 'startColumnIndex' + property :start_row_index, as: 'startRowIndex' + property :end_row_index, as: 'endRowIndex' + property :end_column_index, as: 'endColumnIndex' + end + end + + class DeleteSheetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sheet_id, as: 'sheetId' + end + end + + class UpdateBandingRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :banded_range, as: 'bandedRange', class: Google::Apis::SheetsV4::BandedRange, decorator: Google::Apis::SheetsV4::BandedRange::Representation + + property :fields, as: 'fields' + end + end + + class ChartData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source_range, as: 'sourceRange', class: Google::Apis::SheetsV4::ChartSourceRange, decorator: Google::Apis::SheetsV4::ChartSourceRange::Representation + + end + end + class Sheet # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1659,6 +1956,122 @@ module Google end end + class CopyPasteRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :paste_type, as: 'pasteType' + property :paste_orientation, as: 'pasteOrientation' + property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :destination, as: 'destination', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + end + end + + class UpdateCellsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rows, as: 'rows', class: Google::Apis::SheetsV4::RowData, decorator: Google::Apis::SheetsV4::RowData::Representation + + property :fields, as: 'fields' + property :start, as: 'start', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation + + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + end + end + + class ExtendedValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :formula_value, as: 'formulaValue' + property :error_value, as: 'errorValue', class: Google::Apis::SheetsV4::ErrorValue, decorator: Google::Apis::SheetsV4::ErrorValue::Representation + + property :bool_value, as: 'boolValue' + property :number_value, as: 'numberValue' + property :string_value, as: 'stringValue' + end + end + + class BatchUpdateSpreadsheetResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :spreadsheet_id, as: 'spreadsheetId' + property :updated_spreadsheet, as: 'updatedSpreadsheet', class: Google::Apis::SheetsV4::Spreadsheet, decorator: Google::Apis::SheetsV4::Spreadsheet::Representation + + collection :replies, as: 'replies', class: Google::Apis::SheetsV4::Response, decorator: Google::Apis::SheetsV4::Response::Representation + + end + end + + class GradientRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :maxpoint, as: 'maxpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation + + property :midpoint, as: 'midpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation + + property :minpoint, as: 'minpoint', class: Google::Apis::SheetsV4::InterpolationPoint, decorator: Google::Apis::SheetsV4::InterpolationPoint::Representation + + end + end + + class CutPasteRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :paste_type, as: 'pasteType' + property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :destination, as: 'destination', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation + + end + end + + class OverlayPosition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :width_pixels, as: 'widthPixels' + property :anchor_cell, as: 'anchorCell', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation + + property :offset_x_pixels, as: 'offsetXPixels' + property :height_pixels, as: 'heightPixels' + property :offset_y_pixels, as: 'offsetYPixels' + end + end + + class AutoFillRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :use_alternate_series, as: 'useAlternateSeries' + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation + + property :source_and_destination, as: 'sourceAndDestination', class: Google::Apis::SheetsV4::SourceAndDestination, decorator: Google::Apis::SheetsV4::SourceAndDestination::Representation + + end + end + + class PieChartSpec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :legend_position, as: 'legendPosition' + property :series, as: 'series', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation + + property :pie_hole, as: 'pieHole' + property :three_dimensional, as: 'threeDimensional' + property :domain, as: 'domain', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation + + end + end + + class UpdateSheetPropertiesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fields, as: 'fields' + property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation + + end + end + class BooleanRule # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1669,284 +2082,46 @@ module Google end end - class FilterCriteria - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :hidden_values, as: 'hiddenValues' - property :condition, as: 'condition', class: Google::Apis::SheetsV4::BooleanCondition, decorator: Google::Apis::SheetsV4::BooleanCondition::Representation - - end - end - - class PivotGroupValueMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :value, as: 'value', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation - - property :collapsed, as: 'collapsed' - end - end - - class Editors - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :users, as: 'users' - collection :groups, as: 'groups' - property :domain_users_can_edit, as: 'domainUsersCanEdit' - end - end - - class UpdateConditionalFormatRuleRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :rule, as: 'rule', class: Google::Apis::SheetsV4::ConditionalFormatRule, decorator: Google::Apis::SheetsV4::ConditionalFormatRule::Representation - - property :index, as: 'index' - property :sheet_id, as: 'sheetId' - property :new_index, as: 'newIndex' - end - end - - class DataValidationRule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :condition, as: 'condition', class: Google::Apis::SheetsV4::BooleanCondition, decorator: Google::Apis::SheetsV4::BooleanCondition::Representation - - property :show_custom_ui, as: 'showCustomUi' - property :strict, as: 'strict' - property :input_message, as: 'inputMessage' - end - end - - class BasicChartDomain - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :domain, as: 'domain', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation - - end - end - - class PasteDataRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :html, as: 'html' - property :coordinate, as: 'coordinate', class: Google::Apis::SheetsV4::GridCoordinate, decorator: Google::Apis::SheetsV4::GridCoordinate::Representation - - property :data, as: 'data' - property :delimiter, as: 'delimiter' - property :type, as: 'type' - end - end - class AppendDimensionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :sheet_id, as: 'sheetId' - property :dimension, as: 'dimension' property :length, as: 'length' + property :dimension, as: 'dimension' end end - class AddNamedRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :named_range, as: 'namedRange', class: Google::Apis::SheetsV4::NamedRange, decorator: Google::Apis::SheetsV4::NamedRange::Representation - - end - end - - class UpdateEmbeddedObjectPositionRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_position, as: 'newPosition', class: Google::Apis::SheetsV4::EmbeddedObjectPosition, decorator: Google::Apis::SheetsV4::EmbeddedObjectPosition::Representation - - property :fields, as: 'fields' - property :object_id_prop, as: 'objectId' - end - end - - class PieChartSpec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :legend_position, as: 'legendPosition' - property :pie_hole, as: 'pieHole' - property :domain, as: 'domain', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation - - property :three_dimensional, as: 'threeDimensional' - property :series, as: 'series', class: Google::Apis::SheetsV4::ChartData, decorator: Google::Apis::SheetsV4::ChartData::Representation - - end - end - - class UpdateFilterViewRequest + class AddFilterViewRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation - property :fields, as: 'fields' end end - class ConditionalFormatRule + class GridProperties # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :ranges, as: 'ranges', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :gradient_rule, as: 'gradientRule', class: Google::Apis::SheetsV4::GradientRule, decorator: Google::Apis::SheetsV4::GradientRule::Representation - - property :boolean_rule, as: 'booleanRule', class: Google::Apis::SheetsV4::BooleanRule, decorator: Google::Apis::SheetsV4::BooleanRule::Representation - + property :row_count, as: 'rowCount' + property :column_count, as: 'columnCount' + property :frozen_row_count, as: 'frozenRowCount' + property :frozen_column_count, as: 'frozenColumnCount' + property :hide_gridlines, as: 'hideGridlines' end end - class CopyPasteRequest + class DeleteNamedRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :paste_type, as: 'pasteType' - property :destination, as: 'destination', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :paste_orientation, as: 'pasteOrientation' + property :named_range_id, as: 'namedRangeId' end end - class Request + class AddChartRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :add_conditional_format_rule, as: 'addConditionalFormatRule', class: Google::Apis::SheetsV4::AddConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::AddConditionalFormatRuleRequest::Representation + property :chart, as: 'chart', class: Google::Apis::SheetsV4::EmbeddedChart, decorator: Google::Apis::SheetsV4::EmbeddedChart::Representation - property :add_named_range, as: 'addNamedRange', class: Google::Apis::SheetsV4::AddNamedRangeRequest, decorator: Google::Apis::SheetsV4::AddNamedRangeRequest::Representation - - property :update_cells, as: 'updateCells', class: Google::Apis::SheetsV4::UpdateCellsRequest, decorator: Google::Apis::SheetsV4::UpdateCellsRequest::Representation - - property :update_spreadsheet_properties, as: 'updateSpreadsheetProperties', class: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest::Representation - - property :delete_embedded_object, as: 'deleteEmbeddedObject', class: Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest, decorator: Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest::Representation - - property :update_filter_view, as: 'updateFilterView', class: Google::Apis::SheetsV4::UpdateFilterViewRequest, decorator: Google::Apis::SheetsV4::UpdateFilterViewRequest::Representation - - property :add_banding, as: 'addBanding', class: Google::Apis::SheetsV4::AddBandingRequest, decorator: Google::Apis::SheetsV4::AddBandingRequest::Representation - - property :append_cells, as: 'appendCells', class: Google::Apis::SheetsV4::AppendCellsRequest, decorator: Google::Apis::SheetsV4::AppendCellsRequest::Representation - - property :auto_resize_dimensions, as: 'autoResizeDimensions', class: Google::Apis::SheetsV4::AutoResizeDimensionsRequest, decorator: Google::Apis::SheetsV4::AutoResizeDimensionsRequest::Representation - - property :cut_paste, as: 'cutPaste', class: Google::Apis::SheetsV4::CutPasteRequest, decorator: Google::Apis::SheetsV4::CutPasteRequest::Representation - - property :merge_cells, as: 'mergeCells', class: Google::Apis::SheetsV4::MergeCellsRequest, decorator: Google::Apis::SheetsV4::MergeCellsRequest::Representation - - property :update_named_range, as: 'updateNamedRange', class: Google::Apis::SheetsV4::UpdateNamedRangeRequest, decorator: Google::Apis::SheetsV4::UpdateNamedRangeRequest::Representation - - property :update_sheet_properties, as: 'updateSheetProperties', class: Google::Apis::SheetsV4::UpdateSheetPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateSheetPropertiesRequest::Representation - - property :delete_dimension, as: 'deleteDimension', class: Google::Apis::SheetsV4::DeleteDimensionRequest, decorator: Google::Apis::SheetsV4::DeleteDimensionRequest::Representation - - property :auto_fill, as: 'autoFill', class: Google::Apis::SheetsV4::AutoFillRequest, decorator: Google::Apis::SheetsV4::AutoFillRequest::Representation - - property :sort_range, as: 'sortRange', class: Google::Apis::SheetsV4::SortRangeRequest, decorator: Google::Apis::SheetsV4::SortRangeRequest::Representation - - property :delete_protected_range, as: 'deleteProtectedRange', class: Google::Apis::SheetsV4::DeleteProtectedRangeRequest, decorator: Google::Apis::SheetsV4::DeleteProtectedRangeRequest::Representation - - property :duplicate_filter_view, as: 'duplicateFilterView', class: Google::Apis::SheetsV4::DuplicateFilterViewRequest, decorator: Google::Apis::SheetsV4::DuplicateFilterViewRequest::Representation - - property :add_chart, as: 'addChart', class: Google::Apis::SheetsV4::AddChartRequest, decorator: Google::Apis::SheetsV4::AddChartRequest::Representation - - property :find_replace, as: 'findReplace', class: Google::Apis::SheetsV4::FindReplaceRequest, decorator: Google::Apis::SheetsV4::FindReplaceRequest::Representation - - property :text_to_columns, as: 'textToColumns', class: Google::Apis::SheetsV4::TextToColumnsRequest, decorator: Google::Apis::SheetsV4::TextToColumnsRequest::Representation - - property :update_chart_spec, as: 'updateChartSpec', class: Google::Apis::SheetsV4::UpdateChartSpecRequest, decorator: Google::Apis::SheetsV4::UpdateChartSpecRequest::Representation - - property :add_sheet, as: 'addSheet', class: Google::Apis::SheetsV4::AddSheetRequest, decorator: Google::Apis::SheetsV4::AddSheetRequest::Representation - - property :update_protected_range, as: 'updateProtectedRange', class: Google::Apis::SheetsV4::UpdateProtectedRangeRequest, decorator: Google::Apis::SheetsV4::UpdateProtectedRangeRequest::Representation - - property :delete_filter_view, as: 'deleteFilterView', class: Google::Apis::SheetsV4::DeleteFilterViewRequest, decorator: Google::Apis::SheetsV4::DeleteFilterViewRequest::Representation - - property :copy_paste, as: 'copyPaste', class: Google::Apis::SheetsV4::CopyPasteRequest, decorator: Google::Apis::SheetsV4::CopyPasteRequest::Representation - - property :insert_dimension, as: 'insertDimension', class: Google::Apis::SheetsV4::InsertDimensionRequest, decorator: Google::Apis::SheetsV4::InsertDimensionRequest::Representation - - property :delete_range, as: 'deleteRange', class: Google::Apis::SheetsV4::DeleteRangeRequest, decorator: Google::Apis::SheetsV4::DeleteRangeRequest::Representation - - property :delete_banding, as: 'deleteBanding', class: Google::Apis::SheetsV4::DeleteBandingRequest, decorator: Google::Apis::SheetsV4::DeleteBandingRequest::Representation - - property :add_filter_view, as: 'addFilterView', class: Google::Apis::SheetsV4::AddFilterViewRequest, decorator: Google::Apis::SheetsV4::AddFilterViewRequest::Representation - - property :set_data_validation, as: 'setDataValidation', class: Google::Apis::SheetsV4::SetDataValidationRequest, decorator: Google::Apis::SheetsV4::SetDataValidationRequest::Representation - - property :update_borders, as: 'updateBorders', class: Google::Apis::SheetsV4::UpdateBordersRequest, decorator: Google::Apis::SheetsV4::UpdateBordersRequest::Representation - - property :delete_conditional_format_rule, as: 'deleteConditionalFormatRule', class: Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest::Representation - - property :repeat_cell, as: 'repeatCell', class: Google::Apis::SheetsV4::RepeatCellRequest, decorator: Google::Apis::SheetsV4::RepeatCellRequest::Representation - - property :clear_basic_filter, as: 'clearBasicFilter', class: Google::Apis::SheetsV4::ClearBasicFilterRequest, decorator: Google::Apis::SheetsV4::ClearBasicFilterRequest::Representation - - property :append_dimension, as: 'appendDimension', class: Google::Apis::SheetsV4::AppendDimensionRequest, decorator: Google::Apis::SheetsV4::AppendDimensionRequest::Representation - - property :update_conditional_format_rule, as: 'updateConditionalFormatRule', class: Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest::Representation - - property :insert_range, as: 'insertRange', class: Google::Apis::SheetsV4::InsertRangeRequest, decorator: Google::Apis::SheetsV4::InsertRangeRequest::Representation - - property :move_dimension, as: 'moveDimension', class: Google::Apis::SheetsV4::MoveDimensionRequest, decorator: Google::Apis::SheetsV4::MoveDimensionRequest::Representation - - property :update_banding, as: 'updateBanding', class: Google::Apis::SheetsV4::UpdateBandingRequest, decorator: Google::Apis::SheetsV4::UpdateBandingRequest::Representation - - property :delete_named_range, as: 'deleteNamedRange', class: Google::Apis::SheetsV4::DeleteNamedRangeRequest, decorator: Google::Apis::SheetsV4::DeleteNamedRangeRequest::Representation - - property :add_protected_range, as: 'addProtectedRange', class: Google::Apis::SheetsV4::AddProtectedRangeRequest, decorator: Google::Apis::SheetsV4::AddProtectedRangeRequest::Representation - - property :duplicate_sheet, as: 'duplicateSheet', class: Google::Apis::SheetsV4::DuplicateSheetRequest, decorator: Google::Apis::SheetsV4::DuplicateSheetRequest::Representation - - property :delete_sheet, as: 'deleteSheet', class: Google::Apis::SheetsV4::DeleteSheetRequest, decorator: Google::Apis::SheetsV4::DeleteSheetRequest::Representation - - property :unmerge_cells, as: 'unmergeCells', class: Google::Apis::SheetsV4::UnmergeCellsRequest, decorator: Google::Apis::SheetsV4::UnmergeCellsRequest::Representation - - property :update_embedded_object_position, as: 'updateEmbeddedObjectPosition', class: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest, decorator: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest::Representation - - property :update_dimension_properties, as: 'updateDimensionProperties', class: Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest::Representation - - property :paste_data, as: 'pasteData', class: Google::Apis::SheetsV4::PasteDataRequest, decorator: Google::Apis::SheetsV4::PasteDataRequest::Representation - - property :set_basic_filter, as: 'setBasicFilter', class: Google::Apis::SheetsV4::SetBasicFilterRequest, decorator: Google::Apis::SheetsV4::SetBasicFilterRequest::Representation - - end - end - - class BooleanCondition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :type, as: 'type' - collection :values, as: 'values', class: Google::Apis::SheetsV4::ConditionValue, decorator: Google::Apis::SheetsV4::ConditionValue::Representation - - end - end - - class GridRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_row_index, as: 'endRowIndex' - property :end_column_index, as: 'endColumnIndex' - property :start_row_index, as: 'startRowIndex' - property :start_column_index, as: 'startColumnIndex' - property :sheet_id, as: 'sheetId' - end - end - - class BasicChartSpec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :domains, as: 'domains', class: Google::Apis::SheetsV4::BasicChartDomain, decorator: Google::Apis::SheetsV4::BasicChartDomain::Representation - - property :header_count, as: 'headerCount' - collection :axis, as: 'axis', class: Google::Apis::SheetsV4::BasicChartAxis, decorator: Google::Apis::SheetsV4::BasicChartAxis::Representation - - property :chart_type, as: 'chartType' - collection :series, as: 'series', class: Google::Apis::SheetsV4::BasicChartSeries, decorator: Google::Apis::SheetsV4::BasicChartSeries::Representation - - property :legend_position, as: 'legendPosition' end end @@ -1960,328 +2135,153 @@ module Google end end - class CellData + class Request # @private class Representation < Google::Apis::Core::JsonRepresentation - property :effective_value, as: 'effectiveValue', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + property :update_embedded_object_position, as: 'updateEmbeddedObjectPosition', class: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest, decorator: Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest::Representation - collection :text_format_runs, as: 'textFormatRuns', class: Google::Apis::SheetsV4::TextFormatRun, decorator: Google::Apis::SheetsV4::TextFormatRun::Representation + property :delete_named_range, as: 'deleteNamedRange', class: Google::Apis::SheetsV4::DeleteNamedRangeRequest, decorator: Google::Apis::SheetsV4::DeleteNamedRangeRequest::Representation - property :formatted_value, as: 'formattedValue' - property :hyperlink, as: 'hyperlink' - property :pivot_table, as: 'pivotTable', class: Google::Apis::SheetsV4::PivotTable, decorator: Google::Apis::SheetsV4::PivotTable::Representation + property :update_named_range, as: 'updateNamedRange', class: Google::Apis::SheetsV4::UpdateNamedRangeRequest, decorator: Google::Apis::SheetsV4::UpdateNamedRangeRequest::Representation - property :user_entered_format, as: 'userEnteredFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation + property :add_filter_view, as: 'addFilterView', class: Google::Apis::SheetsV4::AddFilterViewRequest, decorator: Google::Apis::SheetsV4::AddFilterViewRequest::Representation - property :effective_format, as: 'effectiveFormat', class: Google::Apis::SheetsV4::CellFormat, decorator: Google::Apis::SheetsV4::CellFormat::Representation + property :update_spreadsheet_properties, as: 'updateSpreadsheetProperties', class: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateSpreadsheetPropertiesRequest::Representation - property :note, as: 'note' - property :user_entered_value, as: 'userEnteredValue', class: Google::Apis::SheetsV4::ExtendedValue, decorator: Google::Apis::SheetsV4::ExtendedValue::Representation + property :append_dimension, as: 'appendDimension', class: Google::Apis::SheetsV4::AppendDimensionRequest, decorator: Google::Apis::SheetsV4::AppendDimensionRequest::Representation - property :data_validation, as: 'dataValidation', class: Google::Apis::SheetsV4::DataValidationRule, decorator: Google::Apis::SheetsV4::DataValidationRule::Representation + property :unmerge_cells, as: 'unmergeCells', class: Google::Apis::SheetsV4::UnmergeCellsRequest, decorator: Google::Apis::SheetsV4::UnmergeCellsRequest::Representation + + property :insert_range, as: 'insertRange', class: Google::Apis::SheetsV4::InsertRangeRequest, decorator: Google::Apis::SheetsV4::InsertRangeRequest::Representation + + property :update_protected_range, as: 'updateProtectedRange', class: Google::Apis::SheetsV4::UpdateProtectedRangeRequest, decorator: Google::Apis::SheetsV4::UpdateProtectedRangeRequest::Representation + + property :delete_filter_view, as: 'deleteFilterView', class: Google::Apis::SheetsV4::DeleteFilterViewRequest, decorator: Google::Apis::SheetsV4::DeleteFilterViewRequest::Representation + + property :clear_basic_filter, as: 'clearBasicFilter', class: Google::Apis::SheetsV4::ClearBasicFilterRequest, decorator: Google::Apis::SheetsV4::ClearBasicFilterRequest::Representation + + property :sort_range, as: 'sortRange', class: Google::Apis::SheetsV4::SortRangeRequest, decorator: Google::Apis::SheetsV4::SortRangeRequest::Representation + + property :repeat_cell, as: 'repeatCell', class: Google::Apis::SheetsV4::RepeatCellRequest, decorator: Google::Apis::SheetsV4::RepeatCellRequest::Representation + + property :set_data_validation, as: 'setDataValidation', class: Google::Apis::SheetsV4::SetDataValidationRequest, decorator: Google::Apis::SheetsV4::SetDataValidationRequest::Representation + + property :update_cells, as: 'updateCells', class: Google::Apis::SheetsV4::UpdateCellsRequest, decorator: Google::Apis::SheetsV4::UpdateCellsRequest::Representation + + property :add_sheet, as: 'addSheet', class: Google::Apis::SheetsV4::AddSheetRequest, decorator: Google::Apis::SheetsV4::AddSheetRequest::Representation + + property :update_filter_view, as: 'updateFilterView', class: Google::Apis::SheetsV4::UpdateFilterViewRequest, decorator: Google::Apis::SheetsV4::UpdateFilterViewRequest::Representation + + property :update_sheet_properties, as: 'updateSheetProperties', class: Google::Apis::SheetsV4::UpdateSheetPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateSheetPropertiesRequest::Representation + + property :update_dimension_properties, as: 'updateDimensionProperties', class: Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest, decorator: Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest::Representation + + property :delete_sheet, as: 'deleteSheet', class: Google::Apis::SheetsV4::DeleteSheetRequest, decorator: Google::Apis::SheetsV4::DeleteSheetRequest::Representation + + property :find_replace, as: 'findReplace', class: Google::Apis::SheetsV4::FindReplaceRequest, decorator: Google::Apis::SheetsV4::FindReplaceRequest::Representation + + property :add_protected_range, as: 'addProtectedRange', class: Google::Apis::SheetsV4::AddProtectedRangeRequest, decorator: Google::Apis::SheetsV4::AddProtectedRangeRequest::Representation + + property :delete_protected_range, as: 'deleteProtectedRange', class: Google::Apis::SheetsV4::DeleteProtectedRangeRequest, decorator: Google::Apis::SheetsV4::DeleteProtectedRangeRequest::Representation + + property :update_conditional_format_rule, as: 'updateConditionalFormatRule', class: Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest::Representation + + property :set_basic_filter, as: 'setBasicFilter', class: Google::Apis::SheetsV4::SetBasicFilterRequest, decorator: Google::Apis::SheetsV4::SetBasicFilterRequest::Representation + + property :merge_cells, as: 'mergeCells', class: Google::Apis::SheetsV4::MergeCellsRequest, decorator: Google::Apis::SheetsV4::MergeCellsRequest::Representation + + property :update_banding, as: 'updateBanding', class: Google::Apis::SheetsV4::UpdateBandingRequest, decorator: Google::Apis::SheetsV4::UpdateBandingRequest::Representation + + property :add_chart, as: 'addChart', class: Google::Apis::SheetsV4::AddChartRequest, decorator: Google::Apis::SheetsV4::AddChartRequest::Representation + + property :delete_conditional_format_rule, as: 'deleteConditionalFormatRule', class: Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest::Representation + + property :add_banding, as: 'addBanding', class: Google::Apis::SheetsV4::AddBandingRequest, decorator: Google::Apis::SheetsV4::AddBandingRequest::Representation + + property :delete_banding, as: 'deleteBanding', class: Google::Apis::SheetsV4::DeleteBandingRequest, decorator: Google::Apis::SheetsV4::DeleteBandingRequest::Representation + + property :update_chart_spec, as: 'updateChartSpec', class: Google::Apis::SheetsV4::UpdateChartSpecRequest, decorator: Google::Apis::SheetsV4::UpdateChartSpecRequest::Representation + + property :delete_range, as: 'deleteRange', class: Google::Apis::SheetsV4::DeleteRangeRequest, decorator: Google::Apis::SheetsV4::DeleteRangeRequest::Representation + + property :delete_dimension, as: 'deleteDimension', class: Google::Apis::SheetsV4::DeleteDimensionRequest, decorator: Google::Apis::SheetsV4::DeleteDimensionRequest::Representation + + property :delete_embedded_object, as: 'deleteEmbeddedObject', class: Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest, decorator: Google::Apis::SheetsV4::DeleteEmbeddedObjectRequest::Representation + + property :paste_data, as: 'pasteData', class: Google::Apis::SheetsV4::PasteDataRequest, decorator: Google::Apis::SheetsV4::PasteDataRequest::Representation + + property :add_conditional_format_rule, as: 'addConditionalFormatRule', class: Google::Apis::SheetsV4::AddConditionalFormatRuleRequest, decorator: Google::Apis::SheetsV4::AddConditionalFormatRuleRequest::Representation + + property :update_borders, as: 'updateBorders', class: Google::Apis::SheetsV4::UpdateBordersRequest, decorator: Google::Apis::SheetsV4::UpdateBordersRequest::Representation + + property :auto_resize_dimensions, as: 'autoResizeDimensions', class: Google::Apis::SheetsV4::AutoResizeDimensionsRequest, decorator: Google::Apis::SheetsV4::AutoResizeDimensionsRequest::Representation + + property :duplicate_sheet, as: 'duplicateSheet', class: Google::Apis::SheetsV4::DuplicateSheetRequest, decorator: Google::Apis::SheetsV4::DuplicateSheetRequest::Representation + + property :duplicate_filter_view, as: 'duplicateFilterView', class: Google::Apis::SheetsV4::DuplicateFilterViewRequest, decorator: Google::Apis::SheetsV4::DuplicateFilterViewRequest::Representation + + property :cut_paste, as: 'cutPaste', class: Google::Apis::SheetsV4::CutPasteRequest, decorator: Google::Apis::SheetsV4::CutPasteRequest::Representation + + property :append_cells, as: 'appendCells', class: Google::Apis::SheetsV4::AppendCellsRequest, decorator: Google::Apis::SheetsV4::AppendCellsRequest::Representation + + property :add_named_range, as: 'addNamedRange', class: Google::Apis::SheetsV4::AddNamedRangeRequest, decorator: Google::Apis::SheetsV4::AddNamedRangeRequest::Representation + + property :auto_fill, as: 'autoFill', class: Google::Apis::SheetsV4::AutoFillRequest, decorator: Google::Apis::SheetsV4::AutoFillRequest::Representation + + property :move_dimension, as: 'moveDimension', class: Google::Apis::SheetsV4::MoveDimensionRequest, decorator: Google::Apis::SheetsV4::MoveDimensionRequest::Representation + + property :text_to_columns, as: 'textToColumns', class: Google::Apis::SheetsV4::TextToColumnsRequest, decorator: Google::Apis::SheetsV4::TextToColumnsRequest::Representation + + property :insert_dimension, as: 'insertDimension', class: Google::Apis::SheetsV4::InsertDimensionRequest, decorator: Google::Apis::SheetsV4::InsertDimensionRequest::Representation + + property :copy_paste, as: 'copyPaste', class: Google::Apis::SheetsV4::CopyPasteRequest, decorator: Google::Apis::SheetsV4::CopyPasteRequest::Representation end end - class BatchUpdateSpreadsheetRequest + class BatchGetValuesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :include_spreadsheet_in_response, as: 'includeSpreadsheetInResponse' - collection :response_ranges, as: 'responseRanges' - property :response_include_grid_data, as: 'responseIncludeGridData' - collection :requests, as: 'requests', class: Google::Apis::SheetsV4::Request, decorator: Google::Apis::SheetsV4::Request::Representation + collection :value_ranges, as: 'valueRanges', class: Google::Apis::SheetsV4::ValueRange, decorator: Google::Apis::SheetsV4::ValueRange::Representation + property :spreadsheet_id, as: 'spreadsheetId' end end - class BasicChartAxis - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :format, as: 'format', class: Google::Apis::SheetsV4::TextFormat, decorator: Google::Apis::SheetsV4::TextFormat::Representation - - property :position, as: 'position' - property :title, as: 'title' - end - end - - class Padding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bottom, as: 'bottom' - property :top, as: 'top' - property :left, as: 'left' - property :right, as: 'right' - end - end - - class DeleteDimensionRequest + class InsertDimensionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :inherit_from_before, as: 'inheritFromBefore' property :range, as: 'range', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation end end - class UpdateChartSpecRequest + class DeleteEmbeddedObjectRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :spec, as: 'spec', class: Google::Apis::SheetsV4::ChartSpec, decorator: Google::Apis::SheetsV4::ChartSpec::Representation - - property :chart_id, as: 'chartId' + property :object_id_prop, as: 'objectId' end end - class DeleteFilterViewRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter_id, as: 'filterId' - end - end - - class BatchUpdateValuesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :total_updated_columns, as: 'totalUpdatedColumns' - property :spreadsheet_id, as: 'spreadsheetId' - property :total_updated_rows, as: 'totalUpdatedRows' - collection :responses, as: 'responses', class: Google::Apis::SheetsV4::UpdateValuesResponse, decorator: Google::Apis::SheetsV4::UpdateValuesResponse::Representation - - property :total_updated_sheets, as: 'totalUpdatedSheets' - property :total_updated_cells, as: 'totalUpdatedCells' - end - end - - class SortRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation - - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - end - end - - class MergeCellsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :merge_type, as: 'mergeType' - end - end - - class AddProtectedRangeRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation - - end - end - - class BatchClearValuesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :ranges, as: 'ranges' - end - end - - class DuplicateFilterViewResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation - - end - end - - class DuplicateSheetResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :properties, as: 'properties', class: Google::Apis::SheetsV4::SheetProperties, decorator: Google::Apis::SheetsV4::SheetProperties::Representation - - end - end - - class TextToColumnsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :delimiter, as: 'delimiter' - property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :delimiter_type, as: 'delimiterType' - end - end - - class ClearBasicFilterRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sheet_id, as: 'sheetId' - end - end - - class BatchUpdateSpreadsheetResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :replies, as: 'replies', class: Google::Apis::SheetsV4::Response, decorator: Google::Apis::SheetsV4::Response::Representation - - property :updated_spreadsheet, as: 'updatedSpreadsheet', class: Google::Apis::SheetsV4::Spreadsheet, decorator: Google::Apis::SheetsV4::Spreadsheet::Representation - - property :spreadsheet_id, as: 'spreadsheetId' - end - end - - class DeleteBandingRequest + class BandedRange # @private class Representation < Google::Apis::Core::JsonRepresentation property :banded_range_id, as: 'bandedRangeId' - end - end + property :row_properties, as: 'rowProperties', class: Google::Apis::SheetsV4::BandingProperties, decorator: Google::Apis::SheetsV4::BandingProperties::Representation - class AppendValuesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :updates, as: 'updates', class: Google::Apis::SheetsV4::UpdateValuesResponse, decorator: Google::Apis::SheetsV4::UpdateValuesResponse::Representation + property :column_properties, as: 'columnProperties', class: Google::Apis::SheetsV4::BandingProperties, decorator: Google::Apis::SheetsV4::BandingProperties::Representation - property :table_range, as: 'tableRange' - property :spreadsheet_id, as: 'spreadsheetId' - end - end - - class MoveDimensionRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :destination_index, as: 'destinationIndex' - property :source, as: 'source', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation + property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation end end - class PivotFilterCriteria - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :visible_values, as: 'visibleValues' - end - end - - class AddFilterViewRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter, as: 'filter', class: Google::Apis::SheetsV4::FilterView, decorator: Google::Apis::SheetsV4::FilterView::Representation - - end - end - - class AddConditionalFormatRuleRequest + class DeleteConditionalFormatRuleResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :rule, as: 'rule', class: Google::Apis::SheetsV4::ConditionalFormatRule, decorator: Google::Apis::SheetsV4::ConditionalFormatRule::Representation - property :index, as: 'index' - end - end - - class ChartSpec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pie_chart, as: 'pieChart', class: Google::Apis::SheetsV4::PieChartSpec, decorator: Google::Apis::SheetsV4::PieChartSpec::Representation - - property :basic_chart, as: 'basicChart', class: Google::Apis::SheetsV4::BasicChartSpec, decorator: Google::Apis::SheetsV4::BasicChartSpec::Representation - - property :hidden_dimension_strategy, as: 'hiddenDimensionStrategy' - property :title, as: 'title' - end - end - - class NumberFormat - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pattern, as: 'pattern' - property :type, as: 'type' - end - end - - class SheetProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :title, as: 'title' - property :tab_color, as: 'tabColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :index, as: 'index' - property :sheet_id, as: 'sheetId' - property :right_to_left, as: 'rightToLeft' - property :hidden, as: 'hidden' - property :sheet_type, as: 'sheetType' - property :grid_properties, as: 'gridProperties', class: Google::Apis::SheetsV4::GridProperties, decorator: Google::Apis::SheetsV4::GridProperties::Representation - - end - end - - class UpdateDimensionPropertiesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fields, as: 'fields' - property :properties, as: 'properties', class: Google::Apis::SheetsV4::DimensionProperties, decorator: Google::Apis::SheetsV4::DimensionProperties::Representation - - property :range, as: 'range', class: Google::Apis::SheetsV4::DimensionRange, decorator: Google::Apis::SheetsV4::DimensionRange::Representation - - end - end - - class SourceAndDestination - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fill_length, as: 'fillLength' - property :source, as: 'source', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - property :dimension, as: 'dimension' - end - end - - class FilterView - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::FilterCriteria, decorator: Google::Apis::SheetsV4::FilterCriteria::Representation - - property :title, as: 'title' - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation - - property :named_range_id, as: 'namedRangeId' - property :filter_view_id, as: 'filterViewId' - end - end - - class BandingProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :second_band_color, as: 'secondBandColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :footer_color, as: 'footerColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :header_color, as: 'headerColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - property :first_band_color, as: 'firstBandColor', class: Google::Apis::SheetsV4::Color, decorator: Google::Apis::SheetsV4::Color::Representation - - end - end - - class AddProtectedRangeResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :protected_range, as: 'protectedRange', class: Google::Apis::SheetsV4::ProtectedRange, decorator: Google::Apis::SheetsV4::ProtectedRange::Representation - - end - end - - class BasicFilter - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :range, as: 'range', class: Google::Apis::SheetsV4::GridRange, decorator: Google::Apis::SheetsV4::GridRange::Representation - - hash :criteria, as: 'criteria', class: Google::Apis::SheetsV4::FilterCriteria, decorator: Google::Apis::SheetsV4::FilterCriteria::Representation - - collection :sort_specs, as: 'sortSpecs', class: Google::Apis::SheetsV4::SortSpec, decorator: Google::Apis::SheetsV4::SortSpec::Representation - end end end diff --git a/generated/google/apis/sheets_v4/service.rb b/generated/google/apis/sheets_v4/service.rb index a50c6a8c0..456e29bdf 100644 --- a/generated/google/apis/sheets_v4/service.rb +++ b/generated/google/apis/sheets_v4/service.rb @@ -46,6 +46,36 @@ module Google super('https://sheets.googleapis.com/', '') end + # Creates a spreadsheet, returning the newly created spreadsheet. + # @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SheetsV4::Spreadsheet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_spreadsheet(spreadsheet_object = nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:post, 'v4/spreadsheets', options) + command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation + command.request_object = spreadsheet_object + command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation + command.response_class = Google::Apis::SheetsV4::Spreadsheet + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + # Returns the spreadsheet at the given ID. # The caller must specify the spreadsheet ID. # By default, data within grids will not be returned. @@ -69,11 +99,11 @@ module Google # @param [Boolean] include_grid_data # True if grid data should be returned. # This parameter is ignored if a field mask was set in the request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -86,45 +116,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, fields: nil, quota_user: nil, options: nil, &block) + def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options) command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation command.response_class = Google::Apis::SheetsV4::Spreadsheet command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.query['ranges'] = ranges unless ranges.nil? command.query['includeGridData'] = include_grid_data unless include_grid_data.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a spreadsheet, returning the newly created spreadsheet. - # @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SheetsV4::Spreadsheet] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v4/spreadsheets', options) - command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation - command.request_object = spreadsheet_object - command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation - command.response_class = Google::Apis::SheetsV4::Spreadsheet command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -147,11 +147,11 @@ module Google # @param [String] spreadsheet_id # The spreadsheet to apply the updates to. # @param [Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest] batch_update_spreadsheet_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -164,104 +164,15 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}:batchUpdate', options) command.request_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest::Representation command.request_object = batch_update_spreadsheet_request_object command.response_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse::Representation command.response_class = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Copies a single sheet from a spreadsheet to another spreadsheet. - # Returns the properties of the newly created sheet. - # @param [String] spreadsheet_id - # The ID of the spreadsheet containing the sheet to copy. - # @param [Fixnum] sheet_id - # The ID of the sheet to copy. - # @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::SheetProperties] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SheetsV4::SheetProperties] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options) - command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation - command.request_object = copy_sheet_to_another_spreadsheet_request_object - command.response_representation = Google::Apis::SheetsV4::SheetProperties::Representation - command.response_class = Google::Apis::SheetsV4::SheetProperties - command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.params['sheetId'] = sheet_id unless sheet_id.nil? command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns one or more ranges of values from a spreadsheet. - # The caller must specify the spreadsheet ID and one or more ranges. - # @param [String] spreadsheet_id - # The ID of the spreadsheet to retrieve data from. - # @param [String] value_render_option - # How values should be represented in the output. - # The default render option is ValueRenderOption.FORMATTED_VALUE. - # @param [String] date_time_render_option - # How dates, times, and durations should be represented in the output. - # This is ignored if value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. - # @param [Array, String] ranges - # The A1 notation of the values to retrieve. - # @param [String] major_dimension - # The major dimension that results should use. - # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, - # then requesting `range=A1:B2,majorDimension=ROWS` will return - # `[[1,2],[3,4]]`, - # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return - # `[[1,3],[2,4]]`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SheetsV4::BatchGetValuesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_get_spreadsheet_values(spreadsheet_id, value_render_option: nil, date_time_render_option: nil, ranges: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options) - command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation - command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse - command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.query['valueRenderOption'] = value_render_option unless value_render_option.nil? - command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil? - command.query['ranges'] = ranges unless ranges.nil? - command.query['majorDimension'] = major_dimension unless major_dimension.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -274,11 +185,11 @@ module Google # @param [String] range # The A1 notation of the values to clear. # @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -291,7 +202,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def clear_values(spreadsheet_id, range, clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options) command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation command.request_object = clear_values_request_object @@ -299,114 +210,96 @@ module Google command.response_class = Google::Apis::SheetsV4::ClearValuesResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.params['range'] = range unless range.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end - # Appends values to a spreadsheet. The input range is used to search for - # existing data and find a "table" within that range. Values will be - # appended to the next row of the table, starting with the first column of - # the table. See the - # [guide](/sheets/guides/values#appending_values) - # and - # [sample code](/sheets/samples/writing#append_values) - # for specific details of how tables are detected and data is appended. - # The caller must specify the spreadsheet ID, range, and - # a valueInputOption. The `valueInputOption` only - # controls how the input data will be added to the sheet (column-wise or - # row-wise), it does not influence what cell the data starts being written - # to. + # Returns one or more ranges of values from a spreadsheet. + # The caller must specify the spreadsheet ID and one or more ranges. # @param [String] spreadsheet_id - # The ID of the spreadsheet to update. - # @param [String] range - # The A1 notation of a range to search for a logical table of data. - # Values will be appended after the last row of the table. - # @param [Google::Apis::SheetsV4::ValueRange] value_range_object - # @param [String] value_input_option - # How the input data should be interpreted. - # @param [String] response_date_time_render_option - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is + # The ID of the spreadsheet to retrieve data from. + # @param [Array, String] ranges + # The A1 notation of the values to retrieve. + # @param [String] value_render_option + # How values should be represented in the output. + # The default render option is ValueRenderOption.FORMATTED_VALUE. + # @param [String] date_time_render_option + # How dates, times, and durations should be represented in the output. + # This is ignored if value_render_option is # FORMATTED_VALUE. # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. - # @param [Boolean] include_values_in_response - # Determines if the update response should include the values - # of the cells that were appended. By default, responses - # do not include the updated values. - # @param [String] response_value_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. - # @param [String] insert_data_option - # How the input data should be inserted. - # @param [String] fields - # Selector specifying which fields to include in a partial response. + # @param [String] major_dimension + # The major dimension that results should use. + # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, + # then requesting `range=A1:B2,majorDimension=ROWS` will return + # `[[1,2],[3,4]]`, + # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return + # `[[1,3],[2,4]]`. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::AppendValuesResponse] parsed result object + # @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::SheetsV4::AppendValuesResponse] + # @return [Google::Apis::SheetsV4::BatchGetValuesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, response_value_render_option: nil, insert_data_option: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options) - command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation - command.request_object = value_range_object - command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation - command.response_class = Google::Apis::SheetsV4::AppendValuesResponse + def batch_get_spreadsheet_values(spreadsheet_id, ranges: nil, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options) + command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation + command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.params['range'] = range unless range.nil? - command.query['valueInputOption'] = value_input_option unless value_input_option.nil? - command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil? - command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil? - command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? - command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil? - command.query['fields'] = fields unless fields.nil? + command.query['ranges'] = ranges unless ranges.nil? + command.query['valueRenderOption'] = value_render_option unless value_render_option.nil? + command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil? + command.query['majorDimension'] = major_dimension unless major_dimension.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end - # Clears one or more ranges of values from a spreadsheet. - # The caller must specify the spreadsheet ID and one or more ranges. - # Only values are cleared -- all other properties of the cell (such as - # formatting, data validation, etc..) are kept. + # Sets values in one or more ranges of a spreadsheet. + # The caller must specify the spreadsheet ID, + # a valueInputOption, and one or more + # ValueRanges. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. - # @param [Google::Apis::SheetsV4::BatchClearValuesRequest] batch_clear_values_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::BatchClearValuesResponse] parsed result object + # @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::SheetsV4::BatchClearValuesResponse] + # @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClear', options) - command.request_representation = Google::Apis::SheetsV4::BatchClearValuesRequest::Representation - command.request_object = batch_clear_values_request_object - command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation - command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse + def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options) + command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation + command.request_object = batch_update_values_request_object + command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation + command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -431,11 +324,11 @@ module Google # `[[1,2],[3,4]]`, # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return # `[[1,3],[2,4]]`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -448,7 +341,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_spreadsheet_values(spreadsheet_id, range, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block) + def get_spreadsheet_values(spreadsheet_id, range, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options) command.response_representation = Google::Apis::SheetsV4::ValueRange::Representation command.response_class = Google::Apis::SheetsV4::ValueRange @@ -457,8 +350,78 @@ module Google command.query['valueRenderOption'] = value_render_option unless value_render_option.nil? command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil? command.query['majorDimension'] = major_dimension unless major_dimension.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Appends values to a spreadsheet. The input range is used to search for + # existing data and find a "table" within that range. Values will be + # appended to the next row of the table, starting with the first column of + # the table. See the + # [guide](/sheets/guides/values#appending_values) + # and + # [sample code](/sheets/samples/writing#append_values) + # for specific details of how tables are detected and data is appended. + # The caller must specify the spreadsheet ID, range, and + # a valueInputOption. The `valueInputOption` only + # controls how the input data will be added to the sheet (column-wise or + # row-wise), it does not influence what cell the data starts being written + # to. + # @param [String] spreadsheet_id + # The ID of the spreadsheet to update. + # @param [String] range + # The A1 notation of a range to search for a logical table of data. + # Values will be appended after the last row of the table. + # @param [Google::Apis::SheetsV4::ValueRange] value_range_object + # @param [String] response_value_render_option + # Determines how values in the response should be rendered. + # The default render option is ValueRenderOption.FORMATTED_VALUE. + # @param [String] value_input_option + # How the input data should be interpreted. + # @param [String] response_date_time_render_option + # Determines how dates, times, and durations in the response should be + # rendered. This is ignored if response_value_render_option is + # FORMATTED_VALUE. + # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # @param [Boolean] include_values_in_response + # Determines if the update response should include the values + # of the cells that were appended. By default, responses + # do not include the updated values. + # @param [String] insert_data_option + # How the input data should be inserted. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SheetsV4::AppendValuesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SheetsV4::AppendValuesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, insert_data_option: nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options) + command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation + command.request_object = value_range_object + command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation + command.response_class = Google::Apis::SheetsV4::AppendValuesResponse + command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? + command.params['range'] = range unless range.nil? + command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? + command.query['valueInputOption'] = value_input_option unless value_input_option.nil? + command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil? + command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil? + command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end @@ -470,6 +433,9 @@ module Google # @param [String] range # The A1 notation of the values to update. # @param [Google::Apis::SheetsV4::ValueRange] value_range_object + # @param [String] response_value_render_option + # Determines how values in the response should be rendered. + # The default render option is ValueRenderOption.FORMATTED_VALUE. # @param [String] value_input_option # How the input data should be interpreted. # @param [String] response_date_time_render_option @@ -484,14 +450,11 @@ module Google # If the range to write was larger than than the range actually written, # the response will include all values in the requested range (excluding # trailing empty rows and columns). - # @param [String] response_value_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. - # @param [String] fields - # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -504,7 +467,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, response_value_render_option: nil, fields: nil, quota_user: nil, options: nil, &block) + def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options) command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation command.request_object = value_range_object @@ -512,48 +475,85 @@ module Google command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? command.params['range'] = range unless range.nil? + command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? command.query['valueInputOption'] = value_input_option unless value_input_option.nil? command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil? command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil? - command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end - # Sets values in one or more ranges of a spreadsheet. - # The caller must specify the spreadsheet ID, - # a valueInputOption, and one or more - # ValueRanges. + # Clears one or more ranges of values from a spreadsheet. + # The caller must specify the spreadsheet ID and one or more ranges. + # Only values are cleared -- all other properties of the cell (such as + # formatting, data validation, etc..) are kept. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. - # @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::SheetsV4::BatchClearValuesRequest] batch_clear_values_request_object # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object + # @yieldparam result [Google::Apis::SheetsV4::BatchClearValuesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse] + # @return [Google::Apis::SheetsV4::BatchClearValuesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options) - command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation - command.request_object = batch_update_values_request_object - command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation - command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse + def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClear', options) + command.request_representation = Google::Apis::SheetsV4::BatchClearValuesRequest::Representation + command.request_object = batch_clear_values_request_object + command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation + command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? - command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? + execute_or_queue_command(command, &block) + end + + # Copies a single sheet from a spreadsheet to another spreadsheet. + # Returns the properties of the newly created sheet. + # @param [String] spreadsheet_id + # The ID of the spreadsheet containing the sheet to copy. + # @param [Fixnum] sheet_id + # The ID of the sheet to copy. + # @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SheetsV4::SheetProperties] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SheetsV4::SheetProperties] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) + command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options) + command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation + command.request_object = copy_sheet_to_another_spreadsheet_request_object + command.response_representation = Google::Apis::SheetsV4::SheetProperties::Representation + command.response_class = Google::Apis::SheetsV4::SheetProperties + command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil? + command.params['sheetId'] = sheet_id unless sheet_id.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end diff --git a/generated/google/apis/slides_v1.rb b/generated/google/apis/slides_v1.rb index 9f14d4aa3..169a246d5 100644 --- a/generated/google/apis/slides_v1.rb +++ b/generated/google/apis/slides_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/slides/ module SlidesV1 VERSION = 'V1' - REVISION = '20170111' + REVISION = '20170118' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/webmasters_v3.rb b/generated/google/apis/webmasters_v3.rb index 8324c6aa8..e4fdf4fef 100644 --- a/generated/google/apis/webmasters_v3.rb +++ b/generated/google/apis/webmasters_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/webmaster-tools/ module WebmastersV3 VERSION = 'V3' - REVISION = '20160317' + REVISION = '20170117' # View and manage Search Console data for your verified sites AUTH_WEBMASTERS = 'https://www.googleapis.com/auth/webmasters' diff --git a/generated/google/apis/youtube_analytics_v1.rb b/generated/google/apis/youtube_analytics_v1.rb index ea3b85a4b..c096ab9ef 100644 --- a/generated/google/apis/youtube_analytics_v1.rb +++ b/generated/google/apis/youtube_analytics_v1.rb @@ -25,7 +25,7 @@ module Google # @see http://developers.google.com/youtube/analytics/ module YoutubeAnalyticsV1 VERSION = 'V1' - REVISION = '20170118' + REVISION = '20170123' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtubereporting_v1.rb b/generated/google/apis/youtubereporting_v1.rb index 35f78cc23..f5639ff79 100644 --- a/generated/google/apis/youtubereporting_v1.rb +++ b/generated/google/apis/youtubereporting_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/reporting/v1/reports/ module YoutubereportingV1 VERSION = 'V1' - REVISION = '20170118' + REVISION = '20170122' # View YouTube Analytics reports for your YouTube content AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly' diff --git a/lib/google/apis/version.rb b/lib/google/apis/version.rb index 196e73680..fad830244 100644 --- a/lib/google/apis/version.rb +++ b/lib/google/apis/version.rb @@ -15,7 +15,7 @@ module Google module Apis # Client library version - VERSION = '0.9.23' + VERSION = '0.9.24' # Current operating system # @private diff --git a/script/generate b/script/generate index 8ecdd4f5f..e0257a8b9 100755 --- a/script/generate +++ b/script/generate @@ -46,6 +46,7 @@ API_IDS=(adexchangebuyer:v1.4 \ datastore:v1 \ deploymentmanager:v2 \ dfareporting:v2.6 \ + dfareporting:v2.7 \ discovery:v1 \ dns:v1 \ dns:v2beta1 \