diff --git a/generated/google/apis/adexchangebuyer_v1_3.rb b/generated/google/apis/adexchangebuyer_v1_3.rb index 60e2ec4c1..5735ec1f3 100644 --- a/generated/google/apis/adexchangebuyer_v1_3.rb +++ b/generated/google/apis/adexchangebuyer_v1_3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-exchange/buyer-rest module AdexchangebuyerV1_3 VERSION = 'V1_3' - REVISION = '20191018' + REVISION = '20191108' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer_v1_3/classes.rb b/generated/google/apis/adexchangebuyer_v1_3/classes.rb index c6f930b0f..eb90c3a88 100644 --- a/generated/google/apis/adexchangebuyer_v1_3/classes.rb +++ b/generated/google/apis/adexchangebuyer_v1_3/classes.rb @@ -1193,6 +1193,14 @@ module Google # @return [Array] attr_accessor :languages + # The maximum QPS allocated to this pretargeting configuration, used for + # pretargeting-level QPS limits. By default, this is not set, which indicates + # that there is no QPS limit at the configuration level (a global or account- + # level limit may still be imposed). + # Corresponds to the JSON property `maximumQps` + # @return [Fixnum] + attr_accessor :maximum_qps + # Requests containing any of these mobile carrier ids will match. Values are # from mobile-carriers.csv in the downloadable files section. # Corresponds to the JSON property `mobileCarriers` @@ -1266,6 +1274,7 @@ module Google @is_active = args[:is_active] if args.key?(:is_active) @kind = args[:kind] if args.key?(:kind) @languages = args[:languages] if args.key?(:languages) + @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) @mobile_devices = args[:mobile_devices] if args.key?(:mobile_devices) @mobile_operating_system_versions = args[:mobile_operating_system_versions] if args.key?(:mobile_operating_system_versions) diff --git a/generated/google/apis/adexchangebuyer_v1_3/representations.rb b/generated/google/apis/adexchangebuyer_v1_3/representations.rb index ff8a15089..b580546a6 100644 --- a/generated/google/apis/adexchangebuyer_v1_3/representations.rb +++ b/generated/google/apis/adexchangebuyer_v1_3/representations.rb @@ -463,6 +463,7 @@ module Google property :is_active, as: 'isActive' property :kind, as: 'kind' collection :languages, as: 'languages' + property :maximum_qps, :numeric_string => true, as: 'maximumQps' collection :mobile_carriers, as: 'mobileCarriers' collection :mobile_devices, as: 'mobileDevices' collection :mobile_operating_system_versions, as: 'mobileOperatingSystemVersions' diff --git a/generated/google/apis/adexchangebuyer_v1_4.rb b/generated/google/apis/adexchangebuyer_v1_4.rb index a2a1d59e7..752226323 100644 --- a/generated/google/apis/adexchangebuyer_v1_4.rb +++ b/generated/google/apis/adexchangebuyer_v1_4.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-exchange/buyer-rest module AdexchangebuyerV1_4 VERSION = 'V1_4' - REVISION = '20191018' + REVISION = '20191108' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer_v1_4/classes.rb b/generated/google/apis/adexchangebuyer_v1_4/classes.rb index abd196a70..a3ee86c8f 100644 --- a/generated/google/apis/adexchangebuyer_v1_4/classes.rb +++ b/generated/google/apis/adexchangebuyer_v1_4/classes.rb @@ -2497,6 +2497,14 @@ module Google # @return [Array] attr_accessor :languages + # The maximum QPS allocated to this pretargeting configuration, used for + # pretargeting-level QPS limits. By default, this is not set, which indicates + # that there is no QPS limit at the configuration level (a global or account- + # level limit may still be imposed). + # Corresponds to the JSON property `maximumQps` + # @return [Fixnum] + attr_accessor :maximum_qps + # Requests where the predicted viewability is below the specified decile will # not match. E.g. if the buyer sets this value to 5, requests from slots where # the predicted viewability is below 50% will not match. If the predicted @@ -2591,6 +2599,7 @@ module Google @is_active = args[:is_active] if args.key?(:is_active) @kind = args[:kind] if args.key?(:kind) @languages = args[:languages] if args.key?(:languages) + @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps) @minimum_viewability_decile = args[:minimum_viewability_decile] if args.key?(:minimum_viewability_decile) @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) @mobile_devices = args[:mobile_devices] if args.key?(:mobile_devices) diff --git a/generated/google/apis/adexchangebuyer_v1_4/representations.rb b/generated/google/apis/adexchangebuyer_v1_4/representations.rb index 67ae912f8..82492f633 100644 --- a/generated/google/apis/adexchangebuyer_v1_4/representations.rb +++ b/generated/google/apis/adexchangebuyer_v1_4/representations.rb @@ -1165,6 +1165,7 @@ module Google property :is_active, as: 'isActive' property :kind, as: 'kind' collection :languages, as: 'languages' + property :maximum_qps, :numeric_string => true, as: 'maximumQps' property :minimum_viewability_decile, as: 'minimumViewabilityDecile' collection :mobile_carriers, as: 'mobileCarriers' collection :mobile_devices, as: 'mobileDevices' diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index 326638f51..ffdc1c460 100644 --- a/generated/google/apis/androidpublisher_v3.rb +++ b/generated/google/apis/androidpublisher_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV3 VERSION = 'V3' - REVISION = '20191013' + REVISION = '20191113' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v3/classes.rb b/generated/google/apis/androidpublisher_v3/classes.rb index 52da09163..18e96569e 100644 --- a/generated/google/apis/androidpublisher_v3/classes.rb +++ b/generated/google/apis/androidpublisher_v3/classes.rb @@ -293,6 +293,31 @@ module Google end end + # + class Control + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `modRanges` + # @return [Array] + attr_accessor :mod_ranges + + # + # Corresponds to the JSON property `versionCodes` + # @return [Array] + attr_accessor :version_codes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mod_ranges = args[:mod_ranges] if args.key?(:mod_ranges) + @version_codes = args[:version_codes] if args.key?(:version_codes) + end + end + # class CountryTargeting include Google::Apis::Core::Hashable @@ -1067,6 +1092,62 @@ module Google end end + # + class MendelSampling + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `modRanges` + # @return [Array] + attr_accessor :mod_ranges + + # + # Corresponds to the JSON property `modulus` + # @return [Fixnum] + attr_accessor :modulus + + # + # Corresponds to the JSON property `salt` + # @return [Fixnum] + attr_accessor :salt + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mod_ranges = args[:mod_ranges] if args.key?(:mod_ranges) + @modulus = args[:modulus] if args.key?(:modulus) + @salt = args[:salt] if args.key?(:salt) + end + end + + # + class ModRange + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `end` + # @return [Fixnum] + attr_accessor :end + + # + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end = args[:end] if args.key?(:end) + @start = args[:start] if args.key?(:start) + end + end + # class MonthDay include Google::Apis::Core::Hashable @@ -1902,6 +1983,11 @@ module Google class TrackRelease include Google::Apis::Core::Hashable + # + # Corresponds to the JSON property `controls` + # @return [Array] + attr_accessor :controls + # # Corresponds to the JSON property `countryTargeting` # @return [Google::Apis::AndroidpublisherV3::CountryTargeting] @@ -1919,6 +2005,11 @@ module Google # @return [Array] attr_accessor :release_notes + # + # Corresponds to the JSON property `sampling` + # @return [Google::Apis::AndroidpublisherV3::MendelSampling] + attr_accessor :sampling + # The desired status of this release. # Corresponds to the JSON property `status` # @return [String] @@ -1944,9 +2035,11 @@ module Google # Update properties of this object def update!(**args) + @controls = args[:controls] if args.key?(:controls) @country_targeting = args[:country_targeting] if args.key?(:country_targeting) @name = args[:name] if args.key?(:name) @release_notes = args[:release_notes] if args.key?(:release_notes) + @sampling = args[:sampling] if args.key?(:sampling) @status = args[:status] if args.key?(:status) @user_fraction = args[:user_fraction] if args.key?(:user_fraction) @version_codes = args[:version_codes] if args.key?(:version_codes) diff --git a/generated/google/apis/androidpublisher_v3/representations.rb b/generated/google/apis/androidpublisher_v3/representations.rb index d22a7569a..f81276a53 100644 --- a/generated/google/apis/androidpublisher_v3/representations.rb +++ b/generated/google/apis/androidpublisher_v3/representations.rb @@ -82,6 +82,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Control + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CountryTargeting class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,6 +214,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class MendelSampling + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ModRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MonthDay class Representation < Google::Apis::Core::JsonRepresentation; end @@ -464,6 +482,15 @@ module Google end end + class Control + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :mod_ranges, as: 'modRanges', class: Google::Apis::AndroidpublisherV3::ModRange, decorator: Google::Apis::AndroidpublisherV3::ModRange::Representation + + collection :version_codes, as: 'versionCodes' + end + end + class CountryTargeting # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -683,6 +710,24 @@ module Google end end + class MendelSampling + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :mod_ranges, as: 'modRanges', class: Google::Apis::AndroidpublisherV3::ModRange, decorator: Google::Apis::AndroidpublisherV3::ModRange::Representation + + property :modulus, :numeric_string => true, as: 'modulus' + property :salt, as: 'salt' + end + end + + class ModRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end, :numeric_string => true, as: 'end' + property :start, :numeric_string => true, as: 'start' + end + end + class MonthDay # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -914,11 +959,15 @@ module Google class TrackRelease # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :controls, as: 'controls', class: Google::Apis::AndroidpublisherV3::Control, decorator: Google::Apis::AndroidpublisherV3::Control::Representation + property :country_targeting, as: 'countryTargeting', class: Google::Apis::AndroidpublisherV3::CountryTargeting, decorator: Google::Apis::AndroidpublisherV3::CountryTargeting::Representation property :name, as: 'name' collection :release_notes, as: 'releaseNotes', class: Google::Apis::AndroidpublisherV3::LocalizedText, decorator: Google::Apis::AndroidpublisherV3::LocalizedText::Representation + property :sampling, as: 'sampling', class: Google::Apis::AndroidpublisherV3::MendelSampling, decorator: Google::Apis::AndroidpublisherV3::MendelSampling::Representation + property :status, as: 'status' property :user_fraction, as: 'userFraction' collection :version_codes, as: 'versionCodes' diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index 152beb6cd..bbd8f7b85 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20190929' + REVISION = '20191117' # See, edit, share, and permanently delete all the calendars you can access using Google Calendar AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/calendar_v3/classes.rb b/generated/google/apis/calendar_v3/classes.rb index 6b9e53b69..5e1020aa0 100644 --- a/generated/google/apis/calendar_v3/classes.rb +++ b/generated/google/apis/calendar_v3/classes.rb @@ -1089,7 +1089,7 @@ module Google # @return [Google::Apis::CalendarV3::Event::Creator] attr_accessor :creator - # Description of the event. Optional. + # Description of the event. Can contain HTML. Optional. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description diff --git a/generated/google/apis/calendar_v3/service.rb b/generated/google/apis/calendar_v3/service.rb index 977c4dc33..e445e3fa8 100644 --- a/generated/google/apis/calendar_v3/service.rb +++ b/generated/google/apis/calendar_v3/service.rb @@ -1031,11 +1031,9 @@ module Google # @param [String] event_id # Event identifier. # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [Fixnum] max_attendees # The maximum number of attendees to include in the response. If there are more # than the specified number of attendees, only the participant is returned. @@ -1199,11 +1197,9 @@ module Google # @param [String] event_id # Recurring event identifier. # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [Fixnum] max_attendees # The maximum number of attendees to include in the response. If there are more # than the specified number of attendees, only the participant is returned. @@ -1276,11 +1272,9 @@ module Google # method. If you want to access the primary calendar of the currently logged in # user, use the "primary" keyword. # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [String] i_cal_uid # Specifies event ID in the iCalendar format to be included in the response. # Optional. @@ -1470,11 +1464,9 @@ module Google # Event identifier. # @param [Google::Apis::CalendarV3::Event] event_object # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [Fixnum] conference_data_version # Version number of conference data supported by the API client. Version 0 # assumes no conference data support and ignores conference data in the event's @@ -1591,11 +1583,9 @@ module Google # Event identifier. # @param [Google::Apis::CalendarV3::Event] event_object # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [Fixnum] conference_data_version # Version number of conference data supported by the API client. Version 0 # assumes no conference data support and ignores conference data in the event's @@ -1663,11 +1653,9 @@ module Google # user, use the "primary" keyword. # @param [Google::Apis::CalendarV3::Channel] channel_object # @param [Boolean] always_include_email - # Whether to always include a value in the email field for the organizer, - # creator and attendees, even if no real email is available (i.e. a generated, - # non-working value will be provided). The use of this option is discouraged and - # should only be used by clients which cannot handle the absence of an email - # address value in the mentioned places. Optional. The default is False. + # Deprecated and ignored. A value will always be returned in the email field for + # the organizer, creator and attendees, even if no real email address is + # available (i.e. a generated, non-working value will be provided). # @param [String] i_cal_uid # Specifies event ID in the iCalendar format to be included in the response. # Optional. diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index 628d7f985..11beb25a0 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 = '20191018' + REVISION = '20191115' # 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_v1/classes.rb b/generated/google/apis/cloudresourcemanager_v1/classes.rb index fd143c1dc..205b52df3 100644 --- a/generated/google/apis/cloudresourcemanager_v1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1/classes.rb @@ -1363,8 +1363,8 @@ module Google # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten. Due to blind-set semantics of an etag-less policy, - # 'setIamPolicy' will not fail even if either of incoming or stored policy - # does not meet the version requirements. + # 'setIamPolicy' will not fail even if the incoming policy version does not + # meet the requirements for modifying the stored policy. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1375,11 +1375,12 @@ module Google # rejected. # Operations affecting conditional bindings must specify version 3. This can # be either setting a conditional policy, modifying a conditional binding, - # or removing a conditional binding from the stored conditional policy. + # or removing a binding (conditional or unconditional) from the stored + # conditional policy. # Operations on non-conditional policies may specify any valid value or # leave the field unset. - # If no etag is provided in the call to `setIamPolicy`, any version - # compliance checks on the incoming and/or stored policy is skipped. + # If no etag is provided in the call to `setIamPolicy`, version compliance + # checks against the stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index b28d0dd42..fb0c76168 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 = '20190927' + REVISION = '20191115' # 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/classes.rb b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb index 6f5a60e02..3a00b34a7 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb @@ -634,8 +634,8 @@ module Google # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten. Due to blind-set semantics of an etag-less policy, - # 'setIamPolicy' will not fail even if either of incoming or stored policy - # does not meet the version requirements. + # 'setIamPolicy' will not fail even if the incoming policy version does not + # meet the requirements for modifying the stored policy. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -646,11 +646,12 @@ module Google # rejected. # Operations affecting conditional bindings must specify version 3. This can # be either setting a conditional policy, modifying a conditional binding, - # or removing a conditional binding from the stored conditional policy. + # or removing a binding (conditional or unconditional) from the stored + # conditional policy. # Operations on non-conditional policies may specify any valid value or # leave the field unset. - # If no etag is provided in the call to `setIamPolicy`, any version - # compliance checks on the incoming and/or stored policy is skipped. + # If no etag is provided in the call to `setIamPolicy`, version compliance + # checks against the stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version diff --git a/generated/google/apis/cloudresourcemanager_v2.rb b/generated/google/apis/cloudresourcemanager_v2.rb index 84fb4545c..1cd4b0f0a 100644 --- a/generated/google/apis/cloudresourcemanager_v2.rb +++ b/generated/google/apis/cloudresourcemanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2 VERSION = 'V2' - REVISION = '20191018' + REVISION = '20191115' # 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_v2/classes.rb b/generated/google/apis/cloudresourcemanager_v2/classes.rb index 98cd0b5f7..cf2d0cc3c 100644 --- a/generated/google/apis/cloudresourcemanager_v2/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2/classes.rb @@ -576,8 +576,8 @@ module Google # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten. Due to blind-set semantics of an etag-less policy, - # 'setIamPolicy' will not fail even if either of incoming or stored policy - # does not meet the version requirements. + # 'setIamPolicy' will not fail even if the incoming policy version does not + # meet the requirements for modifying the stored policy. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -588,11 +588,12 @@ module Google # rejected. # Operations affecting conditional bindings must specify version 3. This can # be either setting a conditional policy, modifying a conditional binding, - # or removing a conditional binding from the stored conditional policy. + # or removing a binding (conditional or unconditional) from the stored + # conditional policy. # Operations on non-conditional policies may specify any valid value or # leave the field unset. - # If no etag is provided in the call to `setIamPolicy`, any version - # compliance checks on the incoming and/or stored policy is skipped. + # If no etag is provided in the call to `setIamPolicy`, version compliance + # checks against the stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version diff --git a/generated/google/apis/cloudresourcemanager_v2beta1.rb b/generated/google/apis/cloudresourcemanager_v2beta1.rb index 90d0189a9..9d41b5e1a 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2beta1 VERSION = 'V2beta1' - REVISION = '20191018' + REVISION = '20191115' # 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_v2beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb index 98ceee7d1..fdb83cf0e 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb @@ -576,8 +576,8 @@ module Google # ensure that their change will be applied to the same version of the policy. # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten. Due to blind-set semantics of an etag-less policy, - # 'setIamPolicy' will not fail even if either of incoming or stored policy - # does not meet the version requirements. + # 'setIamPolicy' will not fail even if the incoming policy version does not + # meet the requirements for modifying the stored policy. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -588,11 +588,12 @@ module Google # rejected. # Operations affecting conditional bindings must specify version 3. This can # be either setting a conditional policy, modifying a conditional binding, - # or removing a conditional binding from the stored conditional policy. + # or removing a binding (conditional or unconditional) from the stored + # conditional policy. # Operations on non-conditional policies may specify any valid value or # leave the field unset. - # If no etag is provided in the call to `setIamPolicy`, any version - # compliance checks on the incoming and/or stored policy is skipped. + # If no etag is provided in the call to `setIamPolicy`, version compliance + # checks against the stored policy is skipped. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index 142ecfbc4..3a5f346c8 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20191008' + REVISION = '20191107' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index dfcc429ea..c9b483cee 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -4277,7 +4277,7 @@ module Google # @return [Fixnum] attr_accessor :quantity - # The reason for the cancellation. Orders that are cancelled with a noInventory + # The reason for the cancellation. Orders that are canceled with a noInventory # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. # Corresponds to the JSON property `reason` @@ -5271,7 +5271,15 @@ module Google # - "mpx" # - "uds" # - "efw" - # - "jd logistics" + # - "yunexpress" + # - "china post" + # - "china ems" + # - "singapore post" + # - "pos malaysia" + # - "postnl" + # - "ptt" + # - "eub" + # - "chukou1" # Acceptable values for FR are: # - "colissimo" # - "chronopost" @@ -5283,6 +5291,7 @@ module Google # - "geodis" # - "tnt" # - "la poste" + # - "ups" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -5338,8 +5347,8 @@ module Google class OrderShipmentLineItemShipment include Google::Apis::Core::Hashable - # The ID of the line item that is shipped. Either lineItemId or productId is - # required. + # The ID of the line item that is shipped. This value is assigned by Google when + # an order is created. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id diff --git a/generated/google/apis/content_v2_1.rb b/generated/google/apis/content_v2_1.rb index c886491ad..43f8bd766 100644 --- a/generated/google/apis/content_v2_1.rb +++ b/generated/google/apis/content_v2_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2_1 VERSION = 'V2_1' - REVISION = '20191008' + REVISION = '20191107' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2_1/classes.rb b/generated/google/apis/content_v2_1/classes.rb index 1eda1a545..0cfbe603e 100644 --- a/generated/google/apis/content_v2_1/classes.rb +++ b/generated/google/apis/content_v2_1/classes.rb @@ -3648,7 +3648,7 @@ module Google # @return [Fixnum] attr_accessor :quantity - # The reason for the cancellation. Orders that are cancelled with a noInventory + # The reason for the cancellation. Orders that are canceled with a noInventory # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. # Corresponds to the JSON property `reason` @@ -4659,7 +4659,15 @@ module Google # - "mpx" # - "uds" # - "efw" - # - "jd logistics" + # - "yunexpress" + # - "china post" + # - "china ems" + # - "singapore post" + # - "pos malaysia" + # - "postnl" + # - "ptt" + # - "eub" + # - "chukou1" # Acceptable values for FR are: # - "colissimo" # - "chronopost" @@ -4671,6 +4679,7 @@ module Google # - "geodis" # - "tnt" # - "la poste" + # - "ups" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -4732,8 +4741,8 @@ module Google class OrderShipmentLineItemShipment include Google::Apis::Core::Hashable - # The ID of the line item that is shipped. Either lineItemId or productId is - # required. + # The ID of the line item that is shipped. This value is assigned by Google when + # an order is created. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id diff --git a/generated/google/apis/dfareporting_v3_3.rb b/generated/google/apis/dfareporting_v3_3.rb index f14a81a58..7b78c6ec6 100644 --- a/generated/google/apis/dfareporting_v3_3.rb +++ b/generated/google/apis/dfareporting_v3_3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV3_3 VERSION = 'V3_3' - REVISION = '20190531' + REVISION = '20191112' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v3_3/classes.rb b/generated/google/apis/dfareporting_v3_3/classes.rb index eb32e8e7d..17bff9e0e 100644 --- a/generated/google/apis/dfareporting_v3_3/classes.rb +++ b/generated/google/apis/dfareporting_v3_3/classes.rb @@ -115,6 +115,7 @@ module Google # - "48" for HRK # - "49" for MXN # - "50" for NGN + # - "51" for EGP # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -2385,7 +2386,7 @@ module Google # 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. + # INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. # This field may only be used when calling batchinsert; it is not supported by # batchupdate. This field is mutually exclusive with encryptedUserId, matchId, # mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId @@ -10503,6 +10504,25 @@ module Google # - "11" for "America/Los_Angeles" # - "12" for "Pacific/Auckland" # - "13" for "America/Sao_Paulo" + # - "16" for "America/Asuncion" + # - "17" for "America/Chicago" + # - "18" for "America/Denver" + # - "19" for "America/St_Johns" + # - "20" for "Asia/Dhaka" + # - "21" for "Asia/Jakarta" + # - "22" for "Asia/Kabul" + # - "23" for "Asia/Karachi" + # - "24" for "Asia/Calcutta" + # - "25" for "Asia/Pyongyang" + # - "26" for "Asia/Rangoon" + # - "27" for "Atlantic/Cape_Verde" + # - "28" for "Atlantic/South_Georgia" + # - "29" for "Australia/Adelaide" + # - "30" for "Australia/Lord_Howe" + # - "31" for "Europe/Moscow" + # - "32" for "Pacific/Kiritimati" + # - "35" for "Pacific/Norfolk" + # - "36" for "Pacific/Tongatapu" # Corresponds to the JSON property `reportGenerationTimeZoneId` # @return [Fixnum] attr_accessor :report_generation_time_zone_id diff --git a/generated/google/apis/dfareporting_v3_3/service.rb b/generated/google/apis/dfareporting_v3_3/service.rb index d85690996..8dd1e1592 100644 --- a/generated/google/apis/dfareporting_v3_3/service.rb +++ b/generated/google/apis/dfareporting_v3_3/service.rb @@ -1948,12 +1948,12 @@ module Google # @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. + # Select only change logs whose change time is after 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, Fixnum] object_ids # Select only change logs with these object IDs. # @param [String] object_type diff --git a/generated/google/apis/dfareporting_v3_4.rb b/generated/google/apis/dfareporting_v3_4.rb new file mode 100644 index 000000000..fdb955539 --- /dev/null +++ b/generated/google/apis/dfareporting_v3_4.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_v3_4/service.rb' +require 'google/apis/dfareporting_v3_4/classes.rb' +require 'google/apis/dfareporting_v3_4/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 DfareportingV3_4 + VERSION = 'V3_4' + REVISION = '20191112' + + # 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_v3_4/classes.rb b/generated/google/apis/dfareporting_v3_4/classes.rb new file mode 100644 index 000000000..2c59e8813 --- /dev/null +++ b/generated/google/apis/dfareporting_v3_4/classes.rb @@ -0,0 +1,12717 @@ +# 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 DfareportingV3_4 + + # Contains properties of a Campaign Manager 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 [Fixnum] + 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 + # - "49" for MXN + # - "50" for NGN + # - "51" for EGP + # Corresponds to the JSON property `currencyId` + # @return [Fixnum] + attr_accessor :currency_id + + # Default placement dimensions for this account. + # Corresponds to the JSON property `defaultCreativeSizeId` + # @return [Fixnum] + 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 [Fixnum] + 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, in kilobytes. Value must be + # greater than or equal to 1. + # Corresponds to the JSON property `maximumImageSize` + # @return [Fixnum] + 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::DfareportingV3_4::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. Acceptable values + # are 1 to 10240, inclusive. + # Corresponds to the JSON property `teaserSizeLimit` + # @return [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # Ads that have been activated for the account + # Corresponds to the JSON property `activeAds` + # @return [Fixnum] + 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 [Fixnum] + 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 Campaign Manager 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 Campaign Manager 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 [Fixnum] + 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::DfareportingV3_4::ObjectFilter] + attr_accessor :advertiser_filter + + # Object Filter. + # Corresponds to the JSON property `campaignFilter` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :subaccount_id + + # Trafficker type of this user profile. This is a read-only field. + # 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::DfareportingV3_4::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 [Fixnum] + 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 Campaign Manager 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :audience_segment_id + + # Campaign ID of this ad. This is a required field on insertion. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_4::ClickThroughUrl] + attr_accessor :click_through_url + + # Click Through URL Suffix settings. + # Corresponds to the JSON property `clickThroughUrlSuffixProperties` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::CreativeRotation] + attr_accessor :creative_rotation + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # Delivery Schedule. + # Corresponds to the JSON property `deliverySchedule` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::GeoTargeting] + attr_accessor :geo_targeting + + # ID of this ad. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :id_dimension_value + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LanguageTargeting] + attr_accessor :language_targeting + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :targeting_template_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV3_4::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 + + # Campaign ad blocking settings. + class AdBlockingConfiguration + include Google::Apis::Core::Hashable + + # Click-through URL used by brand-neutral ads. This is a required field when + # overrideClickThroughUrl is set to true. + # Corresponds to the JSON property `clickThroughUrl` + # @return [String] + attr_accessor :click_through_url + + # ID of a creative bundle to use for this campaign. If set, brand-neutral ads + # will select creatives from this bundle. Otherwise, a default transparent pixel + # will be used. + # Corresponds to the JSON property `creativeBundleId` + # @return [Fixnum] + attr_accessor :creative_bundle_id + + # Whether this campaign has enabled ad blocking. When true, ad blocking is + # enabled for placements in the campaign, but this may be overridden by site and + # placement settings. When false, ad blocking is disabled for all placements + # under the campaign, regardless of site and placement settings. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # Whether the brand-neutral ad's click-through URL comes from the campaign's + # creative bundle or the override URL. Must be set to true if ad blocking is + # enabled and no creative bundle is configured. + # Corresponds to the JSON property `overrideClickThroughUrl` + # @return [Boolean] + attr_accessor :override_click_through_url + alias_method :override_click_through_url?, :override_click_through_url + + 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_bundle_id = args[:creative_bundle_id] if args.key?(:creative_bundle_id) + @enabled = args[:enabled] if args.key?(:enabled) + @override_click_through_url = args[:override_click_through_url] if args.key?(:override_click_through_url) + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 Campaign Manager 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # ID of this advertiser group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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 + + # Landing Page List Response + class AdvertiserLandingPagesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserLandingPagesListResponse". + # 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 + + # 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) + @kind = args[:kind] if args.key?(:kind) + @landing_pages = args[:landing_pages] if args.key?(:landing_pages) + @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 + + # Annotate a click event. + class AnnotateClickEvent + include Google::Apis::Core::Hashable + + # The Google click ID. Use this field to annotate the click associated with the + # gclid. + # Corresponds to the JSON property `gclid` + # @return [String] + attr_accessor :gclid + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#annotateClickEvent". + # 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) + @gclid = args[:gclid] if args.key?(:gclid) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Audience Segment. + class AudienceSegment + include Google::Apis::Core::Hashable + + # Weight allocated to this segment. The weight assigned will be understood in + # proportion to the weights assigned to other segments in the same segment group. + # Acceptable values are 1 to 1000, inclusive. + # 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 Campaign Manager 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 [Fixnum] + attr_accessor :account_id + + # Campaign ad blocking settings. + # Corresponds to the JSON property `adBlockingConfiguration` + # @return [Google::Apis::DfareportingV3_4::AdBlockingConfiguration] + attr_accessor :ad_blocking_configuration + + # 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 [Fixnum] + attr_accessor :advertiser_group_id + + # Advertiser ID of this campaign. This is a required field. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 Campaign Manager 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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # The default landing page ID for this campaign. + # Corresponds to the JSON property `defaultLandingPageId` + # @return [Fixnum] + attr_accessor :default_landing_page_id + + # 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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LastModifiedInfo] + attr_accessor :last_modified_info + + # 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 [Fixnum] + 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) + @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration) + @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) + @default_landing_page_id = args[:default_landing_page_id] if args.key?(:default_landing_page_id) + @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) + @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 [Fixnum] + 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 Manager IDs related to the custom event. + class CampaignManagerIds + include Google::Apis::Core::Hashable + + # Ad ID for Campaign Manager. + # Corresponds to the JSON property `adId` + # @return [Fixnum] + attr_accessor :ad_id + + # Campaign ID for Campaign Manager. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Creative ID for Campaign Manager. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignManagerIds". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Placement ID for Campaign Manager. + # Corresponds to the JSON property `placementId` + # @return [Fixnum] + attr_accessor :placement_id + + # Site ID for Campaign Manager. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ad_id = args[:ad_id] if args.key?(:ad_id) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @kind = args[:kind] if args.key?(:kind) + @placement_id = args[:placement_id] if args.key?(:placement_id) + @site_id = args[:site_id] if args.key?(:site_id) + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :transaction_id + + # ID of the user who modified the object. + # Corresponds to the JSON property `userProfileId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_4::CreativeClickThroughUrl] + attr_accessor :click_through_url + + # 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 + + 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) + @event_name = args[:event_name] if args.key?(:event_name) + @name = args[:name] if args.key?(:name) + 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 [Fixnum] + 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::DfareportingV3_4::ClickThroughUrl] + attr_accessor :click_through_url + + # ID of the creative for this companion click-through override. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + 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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # ID of this content category. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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 this particular request may come from a user under the age of 13, + # under COPPA compliance. + # 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[], + # matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or + # matchId or mobileDeviceId or gclid 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 + # INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. + # This field may only be used when calling batchinsert; it is not supported by + # batchupdate. This field is mutually exclusive with encryptedUserId, matchId, + # mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId + # or gclid 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 [Fixnum] + attr_accessor :floodlight_activity_id + + # Floodlight Configuration ID of this conversion. This is a required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # The Google click ID. This field is mutually exclusive with encryptedUserId, + # encryptedUserIdCandidates[], matchId and mobileDeviceId. This or + # encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is + # a required field. + # Corresponds to the JSON property `gclid` + # @return [String] + attr_accessor :gclid + + # 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 match ID field. A match ID is your own first-party identifier that has + # been synced with Google using the match ID feature in Floodlight. This field + # is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], + # mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[ + # ] or mobileDeviceId or gclid is a required field. + # Corresponds to the JSON property `matchId` + # @return [String] + attr_accessor :match_id + + # The mobile device ID. This field is mutually exclusive with encryptedUserId, + # encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or + # encryptedUserIdCandidates[] or matchId or gclid is a required field. + # Corresponds to the JSON property `mobileDeviceId` + # @return [String] + attr_accessor :mobile_device_id + + # Whether the conversion was for a non personalized ad. + # Corresponds to the JSON property `nonPersonalizedAd` + # @return [Boolean] + attr_accessor :non_personalized_ad + alias_method :non_personalized_ad?, :non_personalized_ad + + # 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 [Fixnum] + attr_accessor :quantity + + # The timestamp of conversion, in Unix epoch micros. This is a required field. + # Corresponds to the JSON property `timestampMicros` + # @return [Fixnum] + attr_accessor :timestamp_micros + + # Whether this particular request may come from a user under the age of 16 (may + # differ by country), under compliance with the European Union's General Data + # Protection Regulation (GDPR). + # Corresponds to the JSON property `treatmentForUnderage` + # @return [Boolean] + attr_accessor :treatment_for_underage + alias_method :treatment_for_underage?, :treatment_for_underage + + # 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) + @gclid = args[:gclid] if args.key?(:gclid) + @kind = args[:kind] if args.key?(:kind) + @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking) + @match_id = args[:match_id] if args.key?(:match_id) + @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) + @non_personalized_ad = args[:non_personalized_ad] if args.key?(:non_personalized_ad) + @ordinal = args[:ordinal] if args.key?(:ordinal) + @quantity = args[:quantity] if args.key?(:quantity) + @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) + @treatment_for_underage = args[:treatment_for_underage] if args.key?(:treatment_for_underage) + @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::DfareportingV3_4::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::DfareportingV3_4::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 insert status of each conversion. Statuses are 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 + + # Update Conversions Request. + class ConversionsBatchUpdateRequest + include Google::Apis::Core::Hashable + + # The set of conversions to update. + # 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::DfareportingV3_4::EncryptionInfo] + attr_accessor :encryption_info + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchUpdateRequest". + # 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 + + # Update Conversions Response. + class ConversionsBatchUpdateResponse + include Google::Apis::Core::Hashable + + # Indicates that some or all conversions failed to update. + # 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#conversionsBatchUpdateResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The update status of each conversion. Statuses are returned in the same order + # that conversions are updated. + # 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 [Fixnum] + 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 [Fixnum] + 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 + + # Additional sizes associated with a responsive creative. When inserting or + # updating a creative either the size ID field or size width and height fields + # can be used. Applicable to DISPLAY creatives when the primary asset type is + # HTML_IMAGE. + # Corresponds to the JSON property `additionalSizes` + # @return [Array] + attr_accessor :additional_sizes + + # Advertiser ID of this creative. This is a required field. Applicable to all + # creative types. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + 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 `autoAdvanceImages` + # @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 + # Corresponds to the JSON property `backupImageClickThroughUrl` + # @return [Google::Apis::DfareportingV3_4::CreativeClickThroughUrl] + 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 Campaign Manager 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::DfareportingV3_4::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 INSTREAM_VIDEO_REDIRECT creatives. + # Corresponds to the JSON property `commercialId` + # @return [String] + attr_accessor :commercial_id + + # List of companion creatives assigned to an in-Stream video creative. + # Acceptable values include IDs of existing flash and image creatives. + # Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO 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. + # IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the + # VAST standard. Applicable to all creative types. + # Acceptable values are: + # - "APP" + # - "APP_INTERSTITIAL" + # - "IN_STREAM_VIDEO" + # - "IN_STREAM_AUDIO" + # - "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::DfareportingV3_4::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::DfareportingV3_4::FsCommand] + attr_accessor :fs_command + + # HTML code for the creative. This is a required field when applicable. This + # field is ignored if htmlCodeLocked is true. 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 generated by Campaign Manager 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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + attr_accessor :latest_trafficked_creative_id + + # Description of the audio or video ad. Applicable to the following creative + # types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + # Corresponds to the JSON property `mediaDescription` + # @return [String] + attr_accessor :media_description + + # Creative audio or video duration in seconds. This is a read-only field. + # Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, + # all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `mediaDuration` + # @return [Float] + attr_accessor :media_duration + + # 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :rendering_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `renderingIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 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::DfareportingV3_4::Size] + attr_accessor :size + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 creative events. Applicable to the + # following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, 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 [Fixnum] + 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 + + # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + # creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + # Corresponds to the JSON property `universalAdId` + # @return [Google::Apis::DfareportingV3_4::UniversalAdId] + attr_accessor :universal_ad_id + + # 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 + + 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) + @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes) + @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) + @media_description = args[:media_description] if args.key?(:media_description) + @media_duration = args[:media_duration] if args.key?(:media_duration) + @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) + @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id) + @version = args[:version] if args.key?(:version) + 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 or audio asset is active. This is a read-only field for + # VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: + # INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Additional sizes associated with this creative asset. HTML5 asset generated by + # compatible software such as GWD will be able to support more sizes this + # creative asset can render. + # Corresponds to the JSON property `additionalSizes` + # @return [Array] + attr_accessor :additional_sizes + + # 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::DfareportingV3_4::CreativeAssetId] + attr_accessor :asset_identifier + + # Audio stream bit rate in kbps. This is a read-only field. Applicable to the + # following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `audioBitRate` + # @return [Fixnum] + attr_accessor :audio_bit_rate + + # Audio sample bit rate in hertz. This is a read-only field. Applicable to the + # following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `audioSampleRate` + # @return [Fixnum] + attr_accessor :audio_sample_rate + + # Creative Custom Event. + # Corresponds to the JSON property `backupImageExit` + # @return [Google::Apis::DfareportingV3_4::CreativeCustomEvent] + attr_accessor :backup_image_exit + + # Detected bit-rate for audio or video asset. This is a read-only field. + # Applicable to the following creative types: INSTREAM_AUDIO, 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::DfareportingV3_4::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. Value must be greater than or equal + # to 0. + # 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 + # Campaign Manager. 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_AUDIO, INSTREAM_VIDEO and + # VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + # 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::DfareportingV3_4::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 [Fixnum] + 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 + + # Video frame rate for video asset in frames per second. This is a read-only + # field. Applicable to the following creative types: INSTREAM_VIDEO and all + # VPAID. + # Corresponds to the JSON property `frameRate` + # @return [Float] + attr_accessor :frame_rate + + # 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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :id_dimension_value + + # Detected duration for audio or video asset. This is a read-only field. + # Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and + # all VPAID. + # Corresponds to the JSON property `mediaDuration` + # @return [Float] + attr_accessor :media_duration + + # Detected MIME type for audio or video asset. This is a read-only field. + # Applicable to the following creative types: INSTREAM_AUDIO, 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::DfareportingV3_4::OffsetPosition] + attr_accessor :offset + + # Orientation of video asset. This is a read-only, auto-generated field. + # Corresponds to the JSON property `orientation` + # @return [String] + attr_accessor :orientation + + # Whether the backup asset is original or changed by the user in Campaign + # Manager. 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 + + # Whether this asset is used as a polite load asset. + # Corresponds to the JSON property `politeLoad` + # @return [Boolean] + attr_accessor :polite_load + alias_method :polite_load?, :polite_load + + # Offset Position. + # Corresponds to the JSON property `position` + # @return [Google::Apis::DfareportingV3_4::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. 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. Acceptable + # values are 0 to 9.99, inclusive. + # 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 Campaign Manager, such as + # Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. + # PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is + # applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. + # TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from + # PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO + # creatives. + # ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset + # videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These + # cannot be added or removed within Campaign Manager. + # 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. + # PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is + # applicable to INSTREAM_AUDIO creatives. + # TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from + # PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. + # 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::DfareportingV3_4::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 + + # 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. 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. Acceptable values are -999999999 to 999999999, + # inclusive. + # 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) + @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes) + @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) + @audio_bit_rate = args[:audio_bit_rate] if args.key?(:audio_bit_rate) + @audio_sample_rate = args[:audio_sample_rate] if args.key?(:audio_sample_rate) + @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) + @frame_rate = args[:frame_rate] if args.key?(:frame_rate) + @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) + @media_duration = args[:media_duration] if args.key?(:media_duration) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @offset = args[:offset] if args.key?(:offset) + @orientation = args[:orientation] if args.key?(:orientation) + @original_backup = args[:original_backup] if args.key?(:original_backup) + @polite_load = args[:polite_load] if args.key?(:polite_load) + @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) + @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::DfareportingV3_4::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 + # Campaign Manager. 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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :creative_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `creativeIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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: + # - DISPLAY + # - 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 + # - 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. Acceptable values are 1 to 65535, + # inclusive. + # 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. Value must be greater than or equal to 1. + # 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 + + # Click-through URL + class CreativeClickThroughUrl + 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 landingPageId is specified then that landing page's URL is assigned to + # this field. + # - Otherwise, 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 landingPageId field is left unset. + # Corresponds to the JSON property `customClickThroughUrl` + # @return [String] + attr_accessor :custom_click_through_url + + # ID of the landing page for the click-through URL. + # Corresponds to the JSON property `landingPageId` + # @return [Fixnum] + 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) + @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) + end + end + + # Creative Custom Event. + class CreativeCustomEvent + include Google::Apis::Core::Hashable + + # Unique ID of this event used by Reporting and Data Transfer. This is a read- + # only field. + # Corresponds to the JSON property `advertiserCustomEventId` + # @return [Fixnum] + 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 Campaign Manager 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 + + # Click-through URL + # Corresponds to the JSON property `exitClickThroughUrl` + # @return [Google::Apis::DfareportingV3_4::CreativeClickThroughUrl] + attr_accessor :exit_click_through_url + + # ID of this event. This is a required field and should not be modified after + # insertion. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Popup Window Properties. + # Corresponds to the JSON property `popupWindowProperties` + # @return [Google::Apis::DfareportingV3_4::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_click_through_url = args[:exit_click_through_url] if args.key?(:exit_click_through_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 [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this creative field. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :creative_field_id + + # ID of the creative field value. + # Corresponds to the JSON property `creativeFieldValueId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this creative group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Subgroup of the creative group. Assign your creative groups to a subgroup 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 to 2, + # inclusive. + # 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 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 + + # Experimental feature (no support provided) A custom event represents a third + # party impression, a third party click, an annotation on a first party + # impression, or an annotation on a first party click. + class CustomEvent + include Google::Apis::Core::Hashable + + # Annotate a click event. + # Corresponds to the JSON property `annotateClickEvent` + # @return [Google::Apis::DfareportingV3_4::AnnotateClickEvent] + attr_accessor :annotate_click_event + + # Custom variables associated with the event. + # Corresponds to the JSON property `customVariables` + # @return [Array] + attr_accessor :custom_variables + + # The type of event. If INSERT, the fields in insertEvent need to be populated. + # If ANNOTATE_CLICK, the fields in annotateClickEvent need to be populated. A + # custom event cannot have both insertEvent and annotateClickEvent populated. + # Corresponds to the JSON property `eventType` + # @return [String] + attr_accessor :event_type + + # Floodlight configuration ID of the advertiser the event is linked to. This is + # a required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # Insert custom event. + # Corresponds to the JSON property `insertEvent` + # @return [Google::Apis::DfareportingV3_4::InsertEvent] + attr_accessor :insert_event + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customEvent". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The ordinal of this custom event. This is a required field. + # Corresponds to the JSON property `ordinal` + # @return [String] + attr_accessor :ordinal + + # The timestamp of this custom event, in Unix epoch micros. This is a required + # field. + # Corresponds to the JSON property `timestampMicros` + # @return [Fixnum] + attr_accessor :timestamp_micros + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotate_click_event = args[:annotate_click_event] if args.key?(:annotate_click_event) + @custom_variables = args[:custom_variables] if args.key?(:custom_variables) + @event_type = args[:event_type] if args.key?(:event_type) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @insert_event = args[:insert_event] if args.key?(:insert_event) + @kind = args[:kind] if args.key?(:kind) + @ordinal = args[:ordinal] if args.key?(:ordinal) + @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) + end + end + + # The error code and description for a custom event that failed to insert. + class CustomEventError + 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#customEventError". + # 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 custom event that was inserted and whether there were any errors. + class CustomEventStatus + include Google::Apis::Core::Hashable + + # Experimental feature (no support provided) A custom event represents a third + # party impression, a third party click, an annotation on a first party + # impression, or an annotation on a first party click. + # Corresponds to the JSON property `customEvent` + # @return [Google::Apis::DfareportingV3_4::CustomEvent] + attr_accessor :custom_event + + # A list of errors related to this custom event. + # Corresponds to the JSON property `errors` + # @return [Array] + attr_accessor :errors + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customEventStatus". + # 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) + @custom_event = args[:custom_event] if args.key?(:custom_event) + @errors = args[:errors] if args.key?(:errors) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Custom Events Request. + class CustomEventsBatchInsertRequest + include Google::Apis::Core::Hashable + + # The set of custom events to insert. + # Corresponds to the JSON property `customEvents` + # @return [Array] + attr_accessor :custom_events + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customEventsBatchInsertRequest". + # 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) + @custom_events = args[:custom_events] if args.key?(:custom_events) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Custom Events Response. + class CustomEventsBatchInsertResponse + include Google::Apis::Core::Hashable + + # Indicates that some or all custom events 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#customEventsBatchInsertResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The insert status of each custom event. Statuses are 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 + + # 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 + + # A custom variable. + class CustomVariables + include Google::Apis::Core::Hashable + + # The index of the custom variable. + # Corresponds to the JSON property `index` + # @return [Fixnum] + attr_accessor :index + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customVariables". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The value of the custom 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) + @index = args[:index] if args.key?(:index) + @kind = args[:kind] if args.key?(:kind) + @value = args[:value] if args.key?(:value) + end + end + + # Custom Viewability Metric + class CustomViewabilityMetric + include Google::Apis::Core::Hashable + + # The attributes, like playtime and percent onscreen, that define the Custom + # Viewability Metric. + # Corresponds to the JSON property `configuration` + # @return [Google::Apis::DfareportingV3_4::CustomViewabilityMetricConfiguration] + attr_accessor :configuration + + # ID of the custom viewability metric. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Name of the custom viewability metric. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @configuration = args[:configuration] if args.key?(:configuration) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + + # The attributes, like playtime and percent onscreen, that define the Custom + # Viewability Metric. + class CustomViewabilityMetricConfiguration + include Google::Apis::Core::Hashable + + # Whether the video must be audible to count an impression. + # Corresponds to the JSON property `audible` + # @return [Boolean] + attr_accessor :audible + alias_method :audible?, :audible + + # The time in milliseconds the video must play for the Custom Viewability Metric + # to count an impression. If both this and timePercent are specified, the + # earlier of the two will be used. + # Corresponds to the JSON property `timeMillis` + # @return [Fixnum] + attr_accessor :time_millis + + # The percentage of video that must play for the Custom Viewability Metric to + # count an impression. If both this and timeMillis are specified, the earlier of + # the two will be used. + # Corresponds to the JSON property `timePercent` + # @return [Fixnum] + attr_accessor :time_percent + + # The percentage of video that must be on screen for the Custom Viewability + # Metric to count an impression. + # Corresponds to the JSON property `viewabilityPercent` + # @return [Fixnum] + attr_accessor :viewability_percent + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audible = args[:audible] if args.key?(:audible) + @time_millis = args[:time_millis] if args.key?(:time_millis) + @time_percent = args[:time_percent] if args.key?(:time_percent) + @viewability_percent = args[:viewability_percent] if args.key?(:viewability_percent) + end + end + + # DV360 IDs related to the custom event. + class Dv3Ids + include Google::Apis::Core::Hashable + + # Campaign ID for DV360. + # Corresponds to the JSON property `dvCampaignId` + # @return [Fixnum] + attr_accessor :dv_campaign_id + + # Creative ID for DV360. + # Corresponds to the JSON property `dvCreativeId` + # @return [Fixnum] + attr_accessor :dv_creative_id + + # Insertion Order ID for DV360. + # Corresponds to the JSON property `dvInsertionOrderId` + # @return [Fixnum] + attr_accessor :dv_insertion_order_id + + # Line Item ID for DV360. + # Corresponds to the JSON property `dvLineItemId` + # @return [Fixnum] + attr_accessor :dv_line_item_id + + # Site ID for DV360. + # Corresponds to the JSON property `dvSiteId` + # @return [Fixnum] + attr_accessor :dv_site_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#dV3Ids". + # 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) + @dv_campaign_id = args[:dv_campaign_id] if args.key?(:dv_campaign_id) + @dv_creative_id = args[:dv_creative_id] if args.key?(:dv_creative_id) + @dv_insertion_order_id = args[:dv_insertion_order_id] if args.key?(:dv_insertion_order_id) + @dv_line_item_id = args[:dv_line_item_id] if args.key?(:dv_line_item_id) + @dv_site_id = args[:dv_site_id] if args.key?(:dv_site_id) + @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, 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. Acceptable values are 0 to 23, inclusive. + # 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 + + # Contains information about a landing page deep link. + class DeepLink + include Google::Apis::Core::Hashable + + # The URL of the mobile app being linked to. + # Corresponds to the JSON property `appUrl` + # @return [String] + attr_accessor :app_url + + # The fallback URL. This URL will be served to users who do not have the mobile + # app installed. + # Corresponds to the JSON property `fallbackUrl` + # @return [String] + attr_accessor :fallback_url + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#deepLink". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Contains information about a mobile app. Used as a landing page deep link. + # Corresponds to the JSON property `mobileApp` + # @return [Google::Apis::DfareportingV3_4::MobileApp] + attr_accessor :mobile_app + + # Ads served to users on these remarketing lists will use this deep link. + # Applicable when mobileApp.directory is APPLE_APP_STORE. + # Corresponds to the JSON property `remarketingListIds` + # @return [Array] + attr_accessor :remarketing_list_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_url = args[:app_url] if args.key?(:app_url) + @fallback_url = args[:fallback_url] if args.key?(:fallback_url) + @kind = args[:kind] if args.key?(:kind) + @mobile_app = args[:mobile_app] if args.key?(:mobile_app) + @remarketing_list_ids = args[:remarketing_list_ids] if args.key?(:remarketing_list_ids) + 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 [Fixnum] + 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::DfareportingV3_4::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 Campaign Manager will serve ad B + # three times as often as ad A. Acceptable values are 1 to 10, inclusive. + # Corresponds to the JSON property `impressionRatio` + # @return [Fixnum] + 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 + + # Google Ad Manager Settings + class DfpSettings + include Google::Apis::Core::Hashable + + # Ad Manager network code for this directory site. + # Corresponds to the JSON property `dfpNetworkCode` + # @return [String] + attr_accessor :dfp_network_code + + # Ad Manager network name for this directory site. + # Corresponds to the JSON property `dfpNetworkName` + # @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 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 + + # ID of this directory site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 + + # Directory Site Settings + # Corresponds to the JSON property `settings` + # @return [Google::Apis::DfareportingV3_4::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) + @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) + @settings = args[:settings] if args.key?(:settings) + @url = args[:url] if args.key?(:url) + 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 + + # Google Ad Manager Settings + # Corresponds to the JSON property `dfpSettings` + # @return [Google::Apis::DfareportingV3_4::DfpSettings] + attr_accessor :dfp_settings + + # Whether this site accepts in-stream video ads. + # Corresponds to the JSON property `instreamVideoPlacementAccepted` + # @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 + + 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) + 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 + # Studio dynamic creatives. Use these labels instead of numeric Campaign Manager + # 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 Display & + # Video 360 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :last_modified_time + + # The ID of the report this file was generated from. + # Corresponds to the JSON property `reportId` + # @return [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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. For global site tags, this is the + # event snippet. + # Corresponds to the JSON property `floodlightActivityTag` + # @return [String] + attr_accessor :floodlight_activity_tag + + # The global snippet section of a global site tag. The global site tag sets new + # cookies on your domain, which will store a unique identifier for a user or the + # ad click that brought the user to your site. Learn more. + # Corresponds to the JSON property `globalSiteTagGlobalSnippet` + # @return [String] + attr_accessor :global_site_tag_global_snippet + + # 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) + @global_site_tag_global_snippet = args[:global_site_tag_global_snippet] if args.key?(:global_site_tag_global_snippet) + @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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Code type used for cache busting in the generated tag. Applicable only when + # floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING + # or UNIQUE_COUNTING. + # 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 [Fixnum] + 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 [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # The type of Floodlight tag this activity will generate. This is a required + # field. + # Corresponds to the JSON property `floodlightTagType` + # @return [String] + attr_accessor :floodlight_tag_type + + # ID of this floodlight activity. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :id_dimension_value + + # 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 + + # The status of the activity. This can only be set to ACTIVE or + # ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot + # be set for Floodlight activities. The DISABLED_POLICY status indicates that a + # Floodlight activity is violating Google policy. Contact your account manager + # for more information. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this floodlight activity. This is a read-only field that can + # be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + 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= parameter 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-100]=" in the tags. Each of these can have a user defined type. + # Acceptable values are U1 to U100, inclusive. + # 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) + @floodlight_tag_type = args[:floodlight_tag_type] if args.key?(:floodlight_tag_type) + @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) + @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) + @status = args[:status] if args.key?(:status) + @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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :directory_site_id + + # Dynamic Tag + # Corresponds to the JSON property `dynamicTag` + # @return [Google::Apis::DfareportingV3_4::FloodlightActivityDynamicTag] + attr_accessor :dynamic_tag + + # Site ID of this dynamic tag. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :account_id + + # Advertiser ID of the parent advertiser of this floodlight configuration. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 + + # Custom Viewability Metric + # Corresponds to the JSON property `customViewabilityMetric` + # @return [Google::Apis::DfareportingV3_4::CustomViewabilityMetric] + attr_accessor :custom_viewability_metric + + # 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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::OmnitureSettings] + attr_accessor :omniture_settings + + # Subaccount ID of this floodlight configuration. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Dynamic and Image Tag Settings. + # Corresponds to the JSON property `tagSettings` + # @return [Google::Apis::DfareportingV3_4::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) + @custom_viewability_metric = args[:custom_viewability_metric] if args.key?(:custom_viewability_metric) + @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) + @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. Acceptable values are 1 to 7776000, inclusive. + # Corresponds to the JSON property `duration` + # @return [Fixnum] + attr_accessor :duration + + # Number of times an individual user can be served the ad within the specified + # duration. Acceptable values are 1 to 15, inclusive. + # Corresponds to the JSON property `impressions` + # @return [Fixnum] + 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 + + # Insert custom event. + class InsertEvent + include Google::Apis::Core::Hashable + + # Campaign Manager IDs related to the custom event. + # Corresponds to the JSON property `cmDimensions` + # @return [Google::Apis::DfareportingV3_4::CampaignManagerIds] + attr_accessor :cm_dimensions + + # DV360 IDs related to the custom event. + # Corresponds to the JSON property `dv3Dimensions` + # @return [Google::Apis::DfareportingV3_4::Dv3Ids] + attr_accessor :dv3_dimensions + + # The type of insert event. + # Corresponds to the JSON property `insertEventType` + # @return [String] + attr_accessor :insert_event_type + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#insertEvent". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The match ID field. A match ID is your own first-party identifier that has + # been synced with Google using the match ID feature in Floodlight. This field + # is mutually exclusive with mobileDeviceId, and at least one of the two fields + # is required. + # Corresponds to the JSON property `matchId` + # @return [String] + attr_accessor :match_id + + # The mobile device ID. This field is mutually exclusive with matchId, and at + # least one of the two fields is required. + # Corresponds to the JSON property `mobileDeviceId` + # @return [String] + attr_accessor :mobile_device_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cm_dimensions = args[:cm_dimensions] if args.key?(:cm_dimensions) + @dv3_dimensions = args[:dv3_dimensions] if args.key?(:dv3_dimensions) + @insert_event_type = args[:insert_event_type] if args.key?(:insert_event_type) + @kind = args[:kind] if args.key?(:kind) + @match_id = args[:match_id] if args.key?(:match_id) + @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) + end + end + + # Represents a buy from the Planning inventory store. + class InventoryItem + include Google::Apis::Core::Hashable + + # Account ID of this inventory item. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Content category ID of this inventory item. + # Corresponds to the JSON property `contentCategoryId` + # @return [Fixnum] + attr_accessor :content_category_id + + # Estimated click-through rate of this inventory item. + # Corresponds to the JSON property `estimatedClickThroughRate` + # @return [Fixnum] + attr_accessor :estimated_click_through_rate + + # Estimated conversion rate of this inventory item. + # Corresponds to the JSON property `estimatedConversionRate` + # @return [Fixnum] + attr_accessor :estimated_conversion_rate + + # ID of this inventory item. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :negotiation_channel_id + + # Order ID of this inventory item. + # Corresponds to the JSON property `orderId` + # @return [Fixnum] + attr_accessor :order_id + + # Placement strategy ID of this inventory item. + # Corresponds to the JSON property `placementStrategyId` + # @return [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Information + # Corresponds to the JSON property `pricing` + # @return [Google::Apis::DfareportingV3_4::Pricing] + attr_accessor :pricing + + # Project ID of this inventory item. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + attr_accessor :project_id + + # RFP ID of this inventory item. + # Corresponds to the JSON property `rfpId` + # @return [Fixnum] + attr_accessor :rfp_id + + # ID of the site this inventory item is associated with. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Subaccount ID of this inventory item. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + 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 + + # Advertiser ID of this landing page. This is a required field. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Whether this landing page has been archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Links that will direct the user to a mobile app, if installed. + # Corresponds to the JSON property `deepLinks` + # @return [Array] + attr_accessor :deep_links + + # ID of this landing page. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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. + # 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) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @archived = args[:archived] if args.key?(:archived) + @deep_links = args[:deep_links] if args.key?(:deep_links) + @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 + + # 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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. Acceptable values are 0 to 90, inclusive. + # 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. Acceptable values are 0 to 90, inclusive. + # 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 [Fixnum] + attr_accessor :country_dart_id + + # DART ID of this metro region. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + 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 [Fixnum] + 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 app. Used as a landing page deep link. + class MobileApp + include Google::Apis::Core::Hashable + + # Mobile app directory. + # Corresponds to the JSON property `directory` + # @return [String] + attr_accessor :directory + + # ID of this mobile app. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileApp". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Publisher name. + # Corresponds to the JSON property `publisherName` + # @return [String] + attr_accessor :publisher_name + + # Title of this mobile app. + # 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) + @directory = args[:directory] if args.key?(:directory) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @publisher_name = args[:publisher_name] if args.key?(:publisher_name) + @title = args[:title] if args.key?(:title) + end + end + + # Mobile app List Response + class MobileAppsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileAppsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Mobile apps collection. + # Corresponds to the JSON property `mobileApps` + # @return [Array] + attr_accessor :mobile_apps + + # 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) + @kind = args[:kind] if args.key?(:kind) + @mobile_apps = args[:mobile_apps] if args.key?(:mobile_apps) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + 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 [Fixnum] + attr_accessor :country_dart_id + + # ID of this mobile carrier. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :floodlight_activity_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightActivityIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :floodlight_activity_id_dimension_value + + # Weight associated with this optimization. The weight assigned will be + # understood in proportion to the weights assigned to the other optimization + # activities. Value must be greater than or equal to 1. + # 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 Planning order. + class Order + include Google::Apis::Core::Hashable + + # Account ID of this order. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this order. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :planning_term_id + + # Project ID of this order. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 Planning order document. + class OrderDocument + include Google::Apis::Core::Hashable + + # Account ID of this order document. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this order document. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :order_id + + # Project ID of this order document. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # Whether this placement opts out of ad blocking. When true, ad blocking is + # disabled for this placement. When false, the campaign and site settings take + # effect. + # Corresponds to the JSON property `adBlockingOptOut` + # @return [Boolean] + attr_accessor :ad_blocking_opt_out + alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out + + # Additional sizes associated with this placement. When inserting or updating a + # placement, only the size ID field is used. + # Corresponds to the JSON property `additionalSizes` + # @return [Array] + attr_accessor :additional_sizes + + # Advertiser ID of this placement. This field can be left blank. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LastModifiedInfo] + attr_accessor :last_modified_info + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :placement_group_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementGroupIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :placement_group_id_dimension_value + + # ID of the placement strategy assigned to this placement. + # Corresponds to the JSON property `placementStrategyId` + # @return [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + 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_INSTREAM_VIDEO_PREFETCH_VAST_3" + # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" + # - "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::DfareportingV3_4::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::DfareportingV3_4::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. + # Note: Flash is no longer supported. This field now defaults to HTML5 when the + # following values are provided: FLASH, BOTH. + # 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) + @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) + @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes) + @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 [Fixnum] + attr_accessor :placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this placement group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :primary_placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `primaryPlacementIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # ID of this placement strategy. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::Size] + attr_accessor :dimension + + # Offset Position. + # Corresponds to the JSON property `offset` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 + + # 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 [Fixnum] + 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) + @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 in nanos (i.e., multipled by 1000000000). + # Acceptable values are 0 to 1000000000000000000, inclusive. + # Corresponds to the JSON property `rateOrCostNanos` + # @return [Fixnum] + 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. Acceptable values are 0 to 10000000000, + # inclusive. + # Corresponds to the JSON property `units` + # @return [Fixnum] + 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 Planning project. + class Project + include Google::Apis::Core::Hashable + + # Account ID of this project. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this project. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + attr_accessor :subaccount_id + + # Number of clicks that the advertiser is targeting. + # Corresponds to the JSON property `targetClicks` + # @return [Fixnum] + attr_accessor :target_clicks + + # Number of conversions that the advertiser is targeting. + # Corresponds to the JSON property `targetConversions` + # @return [Fixnum] + attr_accessor :target_conversions + + # CPA that the advertiser is targeting. + # Corresponds to the JSON property `targetCpaNanos` + # @return [Fixnum] + attr_accessor :target_cpa_nanos + + # CPC that the advertiser is targeting. + # Corresponds to the JSON property `targetCpcNanos` + # @return [Fixnum] + attr_accessor :target_cpc_nanos + + # vCPM from Active View that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmActiveViewNanos` + # @return [Fixnum] + attr_accessor :target_cpm_active_view_nanos + + # CPM that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmNanos` + # @return [Fixnum] + attr_accessor :target_cpm_nanos + + # Number of impressions that the advertiser is targeting. + # Corresponds to the JSON property `targetImpressions` + # @return [Fixnum] + 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 [Fixnum] + attr_accessor :country_dart_id + + # DART ID of this region. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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. Acceptable values are 1 to 540, inclusive. + # Corresponds to the JSON property `lifeSpan` + # @return [Fixnum] + attr_accessor :life_span + + # Remarketing List Population Rule. + # Corresponds to the JSON property `listPopulationRule` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :account_id + + # The report criteria for a report of type "STANDARD". + # Corresponds to the JSON property `criteria` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Report::CrossDimensionReachCriteria] + attr_accessor :cross_dimension_reach_criteria + + # The report's email delivery settings. + # Corresponds to the JSON property `delivery` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::Report::Schedule] + attr_accessor :schedule + + # The subaccount ID to which this report belongs if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [Fixnum] + 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::DfareportingV3_4::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV3_4::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::DateRange] + attr_accessor :date_range + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigId` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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::DfareportingV3_4::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV3_4::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_4::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 42 + # days. + # 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::DfareportingV3_4::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" + # - "16" for "America/Asuncion" + # - "17" for "America/Chicago" + # - "18" for "America/Denver" + # - "19" for "America/St_Johns" + # - "20" for "Asia/Dhaka" + # - "21" for "Asia/Jakarta" + # - "22" for "Asia/Kabul" + # - "23" for "Asia/Karachi" + # - "24" for "Asia/Calcutta" + # - "25" for "Asia/Pyongyang" + # - "26" for "Asia/Rangoon" + # - "27" for "Atlantic/Cape_Verde" + # - "28" for "Atlantic/South_Georgia" + # - "29" for "Australia/Adelaide" + # - "30" for "Australia/Lord_Howe" + # - "31" for "Europe/Moscow" + # - "32" for "Pacific/Kiritimati" + # - "35" for "Pacific/Norfolk" + # - "36" for "Pacific/Tongatapu" + # Corresponds to the JSON property `reportGenerationTimeZoneId` + # @return [Fixnum] + 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::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::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 [Fixnum] + attr_accessor :subaccount_id + + # Video Settings + # Corresponds to the JSON property `videoSettings` + # @return [Google::Apis::DfareportingV3_4::SiteVideoSettings] + attr_accessor :video_settings + + 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) + @video_settings = args[:video_settings] if args.key?(:video_settings) + end + end + + # Companion Settings + class SiteCompanionSetting + include Google::Apis::Core::Hashable + + # Whether companions are disabled for this site template. + # 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 via this site template. 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#siteCompanionSetting". + # 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 + + # 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 [Fixnum] + 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 + + # Whether this site opts out of ad blocking. When true, ad blocking is disabled + # for all placements under the site, regardless of the individual placement + # settings. When false, the campaign and placement settings take effect. + # Corresponds to the JSON property `adBlockingOptOut` + # @return [Boolean] + attr_accessor :ad_blocking_opt_out + alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out + + # 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 + + # Tag Settings + # Corresponds to the JSON property `tagSetting` + # @return [Google::Apis::DfareportingV3_4::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). + # Note: Flash is no longer supported. This field now defaults to HTML5 when the + # following values are provided: FLASH, BOTH. + # 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) + @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) + @disable_new_cookie = args[:disable_new_cookie] if args.key?(:disable_new_cookie) + @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 + + # Skippable Settings + class SiteSkippableSetting + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#siteSkippableSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Video Offset + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DfareportingV3_4::VideoOffset] + attr_accessor :progress_offset + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV3_4::VideoOffset] + attr_accessor :skip_offset + + # Whether the user can skip creatives served to this site. This will act as + # default for new placements created under this site. + # 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 + + # Transcode Settings + class SiteTranscodeSetting + include Google::Apis::Core::Hashable + + # Whitelist of video formats to be served to this site template. 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#siteTranscodeSetting". + # 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 + + # Video Settings + class SiteVideoSettings + include Google::Apis::Core::Hashable + + # Companion Settings + # Corresponds to the JSON property `companionSettings` + # @return [Google::Apis::DfareportingV3_4::SiteCompanionSetting] + attr_accessor :companion_settings + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#siteVideoSettings". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Orientation of a site template used for video. This will act as default for + # new placements created under this site. + # Corresponds to the JSON property `orientation` + # @return [String] + attr_accessor :orientation + + # Skippable Settings + # Corresponds to the JSON property `skippableSettings` + # @return [Google::Apis::DfareportingV3_4::SiteSkippableSetting] + attr_accessor :skippable_settings + + # Transcode Settings + # Corresponds to the JSON property `transcodeSettings` + # @return [Google::Apis::DfareportingV3_4::SiteTranscodeSetting] + 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) + @orientation = args[:orientation] if args.key?(:orientation) + @skippable_settings = args[:skippable_settings] if args.key?(:skippable_settings) + @transcode_settings = args[:transcode_settings] if args.key?(:transcode_settings) + 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. Acceptable values are 0 to 32767, inclusive. + # 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 [Fixnum] + 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. Acceptable values are 0 to 32767, inclusive. + # 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::DfareportingV3_4::VideoOffset] + attr_accessor :progress_offset + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV3_4::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 Campaign Manager 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 [Fixnum] + 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 [Fixnum] + 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. Applicable only when format is + # PLACEMENT_TAG_TRACKING. + # Corresponds to the JSON property `adId` + # @return [Fixnum] + 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. Applicable only when format is + # PLACEMENT_TAG_TRACKING. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + 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 [Fixnum] + attr_accessor :life_span + + # Number of users currently in the list. This is a read-only field. + # Corresponds to the JSON property `listSize` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_4::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV3_4::DayPartTargeting] + attr_accessor :day_part_targeting + + # Geographical Targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :id + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LanguageTargeting] + attr_accessor :language_targeting + + # Remarketing List Targeting Expression. + # Corresponds to the JSON property `listTargetingExpression` + # @return [Google::Apis::DfareportingV3_4::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 [Fixnum] + attr_accessor :subaccount_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV3_4::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 and in-stream audio 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 + + # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + # creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + class UniversalAdId + include Google::Apis::Core::Hashable + + # Registry used for the Ad ID value. + # Corresponds to the JSON property `registry` + # @return [String] + attr_accessor :registry + + # ID value for this creative. Only alphanumeric characters and the following + # symbols are valid: "_/\-". Maximum length is 64 characters. Read only when + # registry is DCM. + # 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) + @registry = args[:registry] if args.key?(:registry) + @value = args[:value] if args.key?(:value) + 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 [Fixnum] + 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 [Fixnum] + attr_accessor :profile_id + + # The sub account ID this profile belongs to if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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 [Fixnum] + 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::DfareportingV3_4::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. Acceptable values are 0 to 100, inclusive. + # Corresponds to the JSON property `offsetPercentage` + # @return [Fixnum] + attr_accessor :offset_percentage + + # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable + # values are 0 to 86399, inclusive. + # 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::DfareportingV3_4::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 + + # Orientation of a video placement. If this value is set, placement will return + # assets matching the specified orientation. + # Corresponds to the JSON property `orientation` + # @return [String] + attr_accessor :orientation + + # Skippable Settings + # Corresponds to the JSON property `skippableSettings` + # @return [Google::Apis::DfareportingV3_4::SkippableSetting] + attr_accessor :skippable_settings + + # Transcode Settings + # Corresponds to the JSON property `transcodeSettings` + # @return [Google::Apis::DfareportingV3_4::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) + @orientation = args[:orientation] if args.key?(:orientation) + @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_v3_4/representations.rb b/generated/google/apis/dfareporting_v3_4/representations.rb new file mode 100644 index 000000000..14f720109 --- /dev/null +++ b/generated/google/apis/dfareporting_v3_4/representations.rb @@ -0,0 +1,4595 @@ +# 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 DfareportingV3_4 + + 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 AdBlockingConfiguration + 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 AdvertiserLandingPagesListResponse + 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 AnnotateClickEvent + 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 CampaignManagerIds + 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 ConversionsBatchUpdateRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchUpdateResponse + 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 CreativeClickThroughUrl + 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 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 CustomEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomEventError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomEventStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomEventsBatchInsertRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomEventsBatchInsertResponse + 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 CustomVariables + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomViewabilityMetric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomViewabilityMetricConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dv3Ids + 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 DeepLink + 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 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 InsertEvent + 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 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 MobileApp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MobileAppsListResponse + 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 SiteCompanionSetting + 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 SiteSkippableSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteTranscodeSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteVideoSettings + 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 UniversalAdId + 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, :numeric_string => true, as: 'countryId' + property :currency_id, :numeric_string => true, as: 'currencyId' + property :default_creative_size_id, :numeric_string => true, as: 'defaultCreativeSizeId' + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :maximum_image_size, :numeric_string => true, as: 'maximumImageSize' + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :reports_configuration, as: 'reportsConfiguration', class: Google::Apis::DfareportingV3_4::ReportsConfiguration, decorator: Google::Apis::DfareportingV3_4::ReportsConfiguration::Representation + + property :share_reports_with_twitter, as: 'shareReportsWithTwitter' + property :teaser_size_limit, :numeric_string => true, as: 'teaserSizeLimit' + end + end + + class AccountActiveAdSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active_ads, :numeric_string => true, as: 'activeAds' + property :active_ads_limit_tier, as: 'activeAdsLimitTier' + property :available_ads, :numeric_string => true, as: 'availableAds' + property :kind, as: 'kind' + end + end + + class AccountPermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_profiles, as: 'accountProfiles' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :level, as: 'level' + property :name, as: 'name' + property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' + end + end + + class AccountPermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::AccountPermissionGroup, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountPermission, decorator: Google::Apis::DfareportingV3_4::AccountPermission::Representation + + property :kind, as: 'kind' + end + end + + class AccountUserProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_filter, as: 'advertiserFilter', class: Google::Apis::DfareportingV3_4::ObjectFilter, decorator: Google::Apis::DfareportingV3_4::ObjectFilter::Representation + + property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV3_4::ObjectFilter, decorator: Google::Apis::DfareportingV3_4::ObjectFilter::Representation + + property :comments, as: 'comments' + property :email, as: 'email' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :name, as: 'name' + property :site_filter, as: 'siteFilter', class: Google::Apis::DfareportingV3_4::ObjectFilter, decorator: Google::Apis::DfareportingV3_4::ObjectFilter::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :trafficker_type, as: 'traffickerType' + property :user_access_type, as: 'userAccessType' + property :user_role_filter, as: 'userRoleFilter', class: Google::Apis::DfareportingV3_4::ObjectFilter, decorator: Google::Apis::DfareportingV3_4::ObjectFilter::Representation + + property :user_role_id, :numeric_string => true, as: 'userRoleId' + end + end + + class AccountUserProfilesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_user_profiles, as: 'accountUserProfiles', class: Google::Apis::DfareportingV3_4::AccountUserProfile, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Account, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :archived, as: 'archived' + property :audience_segment_id, :numeric_string => true, as: 'audienceSegmentId' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_4::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrl::Representation + + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_4::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrlSuffixProperties::Representation + + property :comments, as: 'comments' + property :compatibility, as: 'compatibility' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_4::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_4::CreativeGroupAssignment::Representation + + property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV3_4::CreativeRotation, decorator: Google::Apis::DfareportingV3_4::CreativeRotation::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_4::DayPartTargeting, decorator: Google::Apis::DfareportingV3_4::DayPartTargeting::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_4::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_4::DefaultClickThroughEventTagProperties::Representation + + property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV3_4::DeliverySchedule, decorator: Google::Apis::DfareportingV3_4::DeliverySchedule::Representation + + property :dynamic_click_tracker, as: 'dynamicClickTracker' + property :end_time, as: 'endTime', type: DateTime + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_4::EventTagOverride, decorator: Google::Apis::DfareportingV3_4::EventTagOverride::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_4::GeoTargeting, decorator: Google::Apis::DfareportingV3_4::GeoTargeting::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_4::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_4::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_4::LanguageTargeting, decorator: Google::Apis::DfareportingV3_4::LanguageTargeting::Representation + + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV3_4::PlacementAssignment, decorator: Google::Apis::DfareportingV3_4::PlacementAssignment::Representation + + property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV3_4::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_4::ListTargetingExpression::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :start_time, as: 'startTime', type: DateTime + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_4::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_4::TechnologyTargeting::Representation + + property :type, as: 'type' + end + end + + class AdBlockingConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl' + property :creative_bundle_id, :numeric_string => true, as: 'creativeBundleId' + property :enabled, as: 'enabled' + property :override_click_through_url, as: 'overrideClickThroughUrl' + end + end + + class AdSlot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :height, :numeric_string => true, as: 'height' + property :linked_placement_id, :numeric_string => true, as: 'linkedPlacementId' + property :name, as: 'name' + property :payment_source_type, as: 'paymentSourceType' + property :primary, as: 'primary' + property :width, :numeric_string => true, as: 'width' + end + end + + class AdsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ads, as: 'ads', class: Google::Apis::DfareportingV3_4::Ad, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' + property :click_through_url_suffix, as: 'clickThroughUrlSuffix' + property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' + property :default_email, as: 'defaultEmail' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :original_floodlight_configuration_id, :numeric_string => true, as: 'originalFloodlightConfigurationId' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :suspended, as: 'suspended' + end + end + + class AdvertiserGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, 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::DfareportingV3_4::AdvertiserGroup, decorator: Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AdvertiserLandingPagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV3_4::LandingPage, decorator: Google::Apis::DfareportingV3_4::LandingPage::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class AdvertisersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV3_4::Advertiser, decorator: Google::Apis::DfareportingV3_4::Advertiser::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AnnotateClickEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gclid, as: 'gclid' + property :kind, as: 'kind' + end + end + + class AudienceSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allocation, as: 'allocation' + property :id, :numeric_string => true, 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::DfareportingV3_4::AudienceSegment, decorator: Google::Apis::DfareportingV3_4::AudienceSegment::Representation + + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + end + end + + class Browser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :browser_version_id, :numeric_string => true, as: 'browserVersionId' + property :dart_id, :numeric_string => true, 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::DfareportingV3_4::Browser, decorator: Google::Apis::DfareportingV3_4::Browser::Representation + + property :kind, as: 'kind' + end + end + + class Campaign + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :ad_blocking_configuration, as: 'adBlockingConfiguration', class: Google::Apis::DfareportingV3_4::AdBlockingConfiguration, decorator: Google::Apis::DfareportingV3_4::AdBlockingConfiguration::Representation + + collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV3_4::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_4::CreativeOptimizationConfiguration::Representation + + property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :archived, as: 'archived' + collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV3_4::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV3_4::AudienceSegmentGroup::Representation + + property :billing_invoice_code, as: 'billingInvoiceCode' + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_4::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrlSuffixProperties::Representation + + property :comment, as: 'comment' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + collection :creative_group_ids, as: 'creativeGroupIds' + property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV3_4::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_4::CreativeOptimizationConfiguration::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_4::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_4::DefaultClickThroughEventTagProperties::Representation + + property :default_landing_page_id, :numeric_string => true, as: 'defaultLandingPageId' + property :end_date, as: 'endDate', type: Date + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_4::EventTagOverride, decorator: Google::Apis::DfareportingV3_4::EventTagOverride::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + collection :trafficker_emails, as: 'traffickerEmails' + end + end + + class CampaignCreativeAssociation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_id, :numeric_string => true, 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::DfareportingV3_4::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV3_4::CampaignCreativeAssociation::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CampaignManagerIds + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ad_id, :numeric_string => true, as: 'adId' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :creative_id, :numeric_string => true, as: 'creativeId' + property :kind, as: 'kind' + property :placement_id, :numeric_string => true, as: 'placementId' + property :site_id, :numeric_string => true, as: 'siteId' + end + end + + class CampaignsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaigns, as: 'campaigns', class: Google::Apis::DfareportingV3_4::Campaign, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :action, as: 'action' + property :change_time, as: 'changeTime', type: DateTime + + property :field_name, as: 'fieldName' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :new_value, as: 'newValue' + property :object_id_prop, :numeric_string => true, as: 'objectId' + property :object_type, as: 'objectType' + property :old_value, as: 'oldValue' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :transaction_id, :numeric_string => true, as: 'transactionId' + property :user_profile_id, :numeric_string => true, 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::DfareportingV3_4::ChangeLog, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::City, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :kind, as: 'kind' + property :metro_code, as: 'metroCode' + property :metro_dma_id, :numeric_string => true, as: 'metroDmaId' + property :name, as: 'name' + property :region_code, as: 'regionCode' + property :region_dart_id, :numeric_string => true, as: 'regionDartId' + end + end + + class ClickTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl::Representation + + property :event_name, as: 'eventName' + property :name, as: 'name' + 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, :numeric_string => true, 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::DfareportingV3_4::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrl::Representation + + property :creative_id, :numeric_string => true, 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::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_4::CrossDimensionReachReportCompatibleFields::Representation + + property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV3_4::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV3_4::FloodlightReportCompatibleFields::Representation + + property :kind, as: 'kind' + property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV3_4::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV3_4::PathToConversionReportCompatibleFields::Representation + + property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV3_4::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_4::ReachReportCompatibleFields::Representation + + property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV3_4::ReportCompatibleFields, decorator: Google::Apis::DfareportingV3_4::ReportCompatibleFields::Representation + + end + end + + class ConnectionType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::ConnectionType, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategory, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, 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::DfareportingV3_4::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV3_4::CustomFloodlightVariable::Representation + + property :encrypted_user_id, as: 'encryptedUserId' + collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :gclid, as: 'gclid' + property :kind, as: 'kind' + property :limit_ad_tracking, as: 'limitAdTracking' + property :match_id, as: 'matchId' + property :mobile_device_id, as: 'mobileDeviceId' + property :non_personalized_ad, as: 'nonPersonalizedAd' + property :ordinal, as: 'ordinal' + property :quantity, :numeric_string => true, as: 'quantity' + property :timestamp_micros, :numeric_string => true, as: 'timestampMicros' + property :treatment_for_underage, as: 'treatmentForUnderage' + 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::DfareportingV3_4::Conversion, decorator: Google::Apis::DfareportingV3_4::Conversion::Representation + + collection :errors, as: 'errors', class: Google::Apis::DfareportingV3_4::ConversionError, decorator: Google::Apis::DfareportingV3_4::ConversionError::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchInsertRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_4::Conversion, decorator: Google::Apis::DfareportingV3_4::Conversion::Representation + + property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_4::EncryptionInfo, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ConversionStatus, decorator: Google::Apis::DfareportingV3_4::ConversionStatus::Representation + + end + end + + class ConversionsBatchUpdateRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_4::Conversion, decorator: Google::Apis::DfareportingV3_4::Conversion::Representation + + property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_4::EncryptionInfo, decorator: Google::Apis::DfareportingV3_4::EncryptionInfo::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchUpdateResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_failures, as: 'hasFailures' + property :kind, as: 'kind' + collection :status, as: 'status', class: Google::Apis::DfareportingV3_4::ConversionStatus, decorator: Google::Apis::DfareportingV3_4::ConversionStatus::Representation + + end + end + + class CountriesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_4::Country, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, 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, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :ad_parameters, as: 'adParameters' + collection :ad_tag_keys, as: 'adTagKeys' + collection :additional_sizes, as: 'additionalSizes', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :advertiser_id, :numeric_string => true, 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: 'autoAdvanceImages' + property :background_color, as: 'backgroundColor' + property :backup_image_click_through_url, as: 'backupImageClickThroughUrl', class: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl::Representation + + collection :backup_image_features, as: 'backupImageFeatures' + property :backup_image_reporting_label, as: 'backupImageReportingLabel' + property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV3_4::TargetWindow, decorator: Google::Apis::DfareportingV3_4::TargetWindow::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_4::ClickTag, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + + property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV3_4::CreativeAssetSelection, decorator: Google::Apis::DfareportingV3_4::CreativeAssetSelection::Representation + + collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV3_4::CreativeAsset, decorator: Google::Apis::DfareportingV3_4::CreativeAsset::Representation + + collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV3_4::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV3_4::CreativeFieldAssignment::Representation + + collection :custom_key_values, as: 'customKeyValues' + property :dynamic_asset_selection, as: 'dynamicAssetSelection' + collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + + property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV3_4::FsCommand, decorator: Google::Apis::DfareportingV3_4::FsCommand::Representation + + property :html_code, as: 'htmlCode' + property :html_code_locked, as: 'htmlCodeLocked' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :latest_trafficked_creative_id, :numeric_string => true, as: 'latestTraffickedCreativeId' + property :media_description, as: 'mediaDescription' + property :media_duration, as: 'mediaDuration' + property :name, as: 'name' + property :override_css, as: 'overrideCss' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation + + property :redirect_url, as: 'redirectUrl' + property :rendering_id, :numeric_string => true, as: 'renderingId' + property :rendering_id_dimension_value, as: 'renderingIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' + property :required_flash_version, as: 'requiredFlashVersion' + property :size, as: 'size', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation + + property :skippable, as: 'skippable' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_override, as: 'sslOverride' + property :studio_advertiser_id, :numeric_string => true, as: 'studioAdvertiserId' + property :studio_creative_id, :numeric_string => true, as: 'studioCreativeId' + property :studio_trafficked_creative_id, :numeric_string => true, as: 'studioTraffickedCreativeId' + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV3_4::ThirdPartyTrackingUrl::Representation + + collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + + property :total_file_size, :numeric_string => true, as: 'totalFileSize' + property :type, as: 'type' + property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DfareportingV3_4::UniversalAdId, decorator: Google::Apis::DfareportingV3_4::UniversalAdId::Representation + + property :version, as: 'version' + end + end + + class CreativeAsset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action_script3, as: 'actionScript3' + property :active, as: 'active' + collection :additional_sizes, as: 'additionalSizes', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :alignment, as: 'alignment' + property :artwork_type, as: 'artworkType' + property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV3_4::CreativeAssetId, decorator: Google::Apis::DfareportingV3_4::CreativeAssetId::Representation + + property :audio_bit_rate, as: 'audioBitRate' + property :audio_sample_rate, as: 'audioSampleRate' + property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + + property :bit_rate, as: 'bitRate' + property :child_asset_type, as: 'childAssetType' + property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :file_size, :numeric_string => true, as: 'fileSize' + property :flash_version, as: 'flashVersion' + property :frame_rate, as: 'frameRate' + property :hide_flash_objects, as: 'hideFlashObjects' + property :hide_selection_boxes, as: 'hideSelectionBoxes' + property :horizontally_locked, as: 'horizontallyLocked' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :media_duration, as: 'mediaDuration' + property :mime_type, as: 'mimeType' + property :offset, as: 'offset', class: Google::Apis::DfareportingV3_4::OffsetPosition, decorator: Google::Apis::DfareportingV3_4::OffsetPosition::Representation + + property :orientation, as: 'orientation' + property :original_backup, as: 'originalBackup' + property :polite_load, as: 'politeLoad' + property :position, as: 'position', class: Google::Apis::DfareportingV3_4::OffsetPosition, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::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 :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::DfareportingV3_4::CreativeAssetId, decorator: Google::Apis::DfareportingV3_4::CreativeAssetId::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_4::ClickTag, decorator: Google::Apis::DfareportingV3_4::ClickTag::Representation + + collection :detected_features, as: 'detectedFeatures' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'defaultAssetId' + collection :rules, as: 'rules', class: Google::Apis::DfareportingV3_4::Rule, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrl::Representation + + collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV3_4::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV3_4::CompanionClickThroughOverride::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_4::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_4::CreativeGroupAssignment::Representation + + property :creative_id, :numeric_string => true, as: 'creativeId' + property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :end_time, as: 'endTime', type: DateTime + + collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV3_4::RichMediaExitOverride, decorator: Google::Apis::DfareportingV3_4::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 CreativeClickThroughUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :computed_click_through_url, as: 'computedClickThroughUrl' + property :custom_click_through_url, as: 'customClickThroughUrl' + property :landing_page_id, :numeric_string => true, as: 'landingPageId' + end + end + + class CreativeCustomEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_custom_event_id, :numeric_string => true, 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_click_through_url, as: 'exitClickThroughUrl', class: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::CreativeClickThroughUrl::Representation + + property :id, :numeric_string => true, as: 'id' + property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV3_4::PopupWindowProperties, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class CreativeFieldAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_field_id, :numeric_string => true, as: 'creativeFieldId' + property :creative_field_value_id, :numeric_string => true, as: 'creativeFieldValueId' + end + end + + class CreativeFieldValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::CreativeFieldValue, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeField, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :group_number, as: 'groupNumber' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class CreativeGroupAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_group_id, :numeric_string => true, 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::DfareportingV3_4::CreativeGroup, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'id' + property :name, as: 'name' + collection :optimization_activitys, as: 'optimizationActivitys', class: Google::Apis::DfareportingV3_4::OptimizationActivity, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeAssignment, decorator: Google::Apis::DfareportingV3_4::CreativeAssignment::Representation + + property :creative_optimization_configuration_id, :numeric_string => true, as: 'creativeOptimizationConfigurationId' + property :type, as: 'type' + property :weight_calculation_strategy, as: 'weightCalculationStrategy' + end + end + + class CreativesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creatives, as: 'creatives', class: Google::Apis::DfareportingV3_4::Creative, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + end + end + + class CustomEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :annotate_click_event, as: 'annotateClickEvent', class: Google::Apis::DfareportingV3_4::AnnotateClickEvent, decorator: Google::Apis::DfareportingV3_4::AnnotateClickEvent::Representation + + collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV3_4::CustomVariables, decorator: Google::Apis::DfareportingV3_4::CustomVariables::Representation + + property :event_type, as: 'eventType' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :insert_event, as: 'insertEvent', class: Google::Apis::DfareportingV3_4::InsertEvent, decorator: Google::Apis::DfareportingV3_4::InsertEvent::Representation + + property :kind, as: 'kind' + property :ordinal, as: 'ordinal' + property :timestamp_micros, :numeric_string => true, as: 'timestampMicros' + end + end + + class CustomEventError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :kind, as: 'kind' + property :message, as: 'message' + end + end + + class CustomEventStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_event, as: 'customEvent', class: Google::Apis::DfareportingV3_4::CustomEvent, decorator: Google::Apis::DfareportingV3_4::CustomEvent::Representation + + collection :errors, as: 'errors', class: Google::Apis::DfareportingV3_4::CustomEventError, decorator: Google::Apis::DfareportingV3_4::CustomEventError::Representation + + property :kind, as: 'kind' + end + end + + class CustomEventsBatchInsertRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_events, as: 'customEvents', class: Google::Apis::DfareportingV3_4::CustomEvent, decorator: Google::Apis::DfareportingV3_4::CustomEvent::Representation + + property :kind, as: 'kind' + end + end + + class CustomEventsBatchInsertResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_failures, as: 'hasFailures' + property :kind, as: 'kind' + collection :status, as: 'status', class: Google::Apis::DfareportingV3_4::CustomEventStatus, decorator: Google::Apis::DfareportingV3_4::CustomEventStatus::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::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + end + end + + class CustomVariables + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index, :numeric_string => true, as: 'index' + property :kind, as: 'kind' + property :value, as: 'value' + end + end + + class CustomViewabilityMetric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :configuration, as: 'configuration', class: Google::Apis::DfareportingV3_4::CustomViewabilityMetricConfiguration, decorator: Google::Apis::DfareportingV3_4::CustomViewabilityMetricConfiguration::Representation + + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + end + end + + class CustomViewabilityMetricConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audible, as: 'audible' + property :time_millis, as: 'timeMillis' + property :time_percent, as: 'timePercent' + property :viewability_percent, as: 'viewabilityPercent' + end + end + + class Dv3Ids + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dv_campaign_id, :numeric_string => true, as: 'dvCampaignId' + property :dv_creative_id, :numeric_string => true, as: 'dvCreativeId' + property :dv_insertion_order_id, :numeric_string => true, as: 'dvInsertionOrderId' + property :dv_line_item_id, :numeric_string => true, as: 'dvLineItemId' + property :dv_site_id, :numeric_string => true, as: 'dvSiteId' + 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 DeepLink + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :app_url, as: 'appUrl' + property :fallback_url, as: 'fallbackUrl' + property :kind, as: 'kind' + property :mobile_app, as: 'mobileApp', class: Google::Apis::DfareportingV3_4::MobileApp, decorator: Google::Apis::DfareportingV3_4::MobileApp::Representation + + collection :remarketing_list_ids, as: 'remarketingListIds' + end + end + + class DefaultClickThroughEventTagProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_click_through_event_tag_id, :numeric_string => true, 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::DfareportingV3_4::FrequencyCap, decorator: Google::Apis::DfareportingV3_4::FrequencyCap::Representation + + property :hard_cutoff, as: 'hardCutoff' + property :impression_ratio, :numeric_string => true, as: 'impressionRatio' + property :priority, as: 'priority' + end + end + + class DfpSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dfp_network_code, as: 'dfpNetworkCode' + property :dfp_network_name, as: 'dfpNetworkName' + 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::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DimensionFilter, decorator: Google::Apis::DfareportingV3_4::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' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :inpage_tag_formats, as: 'inpageTagFormats' + collection :interstitial_tag_formats, as: 'interstitialTagFormats' + property :kind, as: 'kind' + property :name, as: 'name' + property :settings, as: 'settings', class: Google::Apis::DfareportingV3_4::DirectorySiteSettings, decorator: Google::Apis::DfareportingV3_4::DirectorySiteSettings::Representation + + property :url, as: 'url' + end + end + + class DirectorySiteSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_opt_out, as: 'activeViewOptOut' + property :dfp_settings, as: 'dfpSettings', class: Google::Apis::DfareportingV3_4::DfpSettings, decorator: Google::Apis::DfareportingV3_4::DfpSettings::Representation + + property :instream_video_placement_accepted, as: 'instreamVideoPlacementAccepted' + property :interstitial_placement_accepted, as: 'interstitialPlacementAccepted' + end + end + + class DirectorySitesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :directory_sites, as: 'directorySites', class: Google::Apis::DfareportingV3_4::DirectorySite, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, 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::DfareportingV3_4::DynamicTargetingKey, decorator: Google::Apis::DfareportingV3_4::DynamicTargetingKey::Representation + + property :kind, as: 'kind' + end + end + + class EncryptionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :encryption_entity_id, :numeric_string => true, 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, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :enabled_by_default, as: 'enabledByDefault' + property :exclude_from_adx_requests, as: 'excludeFromAdxRequests' + property :id, :numeric_string => true, 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, :numeric_string => true, 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, :numeric_string => true, as: 'id' + end + end + + class EventTagsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :event_tags, as: 'eventTags', class: Google::Apis::DfareportingV3_4::EventTag, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :format, as: 'format' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' + property :report_id, :numeric_string => true, as: 'reportId' + property :status, as: 'status' + property :urls, as: 'urls', class: Google::Apis::DfareportingV3_4::File::Urls, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::File, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'rateOrCost' + property :start_date, as: 'startDate', type: Date + + property :units, :numeric_string => true, as: 'units' + end + end + + class FloodlightActivitiesGenerateTagResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_tag, as: 'floodlightActivityTag' + property :global_site_tag_global_snippet, as: 'globalSiteTagGlobalSnippet' + property :kind, as: 'kind' + end + end + + class FloodlightActivitiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV3_4::FloodlightActivity, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :cache_busting_type, as: 'cacheBustingType' + property :counting_method, as: 'countingMethod' + collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV3_4::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_4::FloodlightActivityDynamicTag::Representation + + property :expected_url, as: 'expectedUrl' + property :floodlight_activity_group_id, :numeric_string => true, 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, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :floodlight_tag_type, as: 'floodlightTagType' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :notes, as: 'notes' + collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV3_4::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV3_4::FloodlightActivityPublisherDynamicTag::Representation + + property :secure, as: 'secure' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, 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, :numeric_string => true, as: 'id' + property :name, as: 'name' + property :tag, as: 'tag' + end + end + + class FloodlightActivityGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'directorySiteId' + property :dynamic_tag, as: 'dynamicTag', class: Google::Apis::DfareportingV3_4::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_4::FloodlightActivityDynamicTag::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :view_through, as: 'viewThrough' + end + end + + class FloodlightConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :analytics_data_sharing_enabled, as: 'analyticsDataSharingEnabled' + property :custom_viewability_metric, as: 'customViewabilityMetric', class: Google::Apis::DfareportingV3_4::CustomViewabilityMetric, decorator: Google::Apis::DfareportingV3_4::CustomViewabilityMetric::Representation + + property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' + property :first_day_of_week, as: 'firstDayOfWeek' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' + property :kind, as: 'kind' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_4::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_4::LookbackConfiguration::Representation + + property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' + property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV3_4::OmnitureSettings, decorator: Google::Apis::DfareportingV3_4::OmnitureSettings::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV3_4::TagSettings, decorator: Google::Apis::DfareportingV3_4::TagSettings::Representation + + collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV3_4::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV3_4::ThirdPartyAuthenticationToken::Representation + + collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV3_4::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV3_4::UserDefinedVariableConfiguration::Representation + + end + end + + class FloodlightConfigurationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV3_4::FloodlightConfiguration, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + end + end + + class FrequencyCap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, :numeric_string => true, as: 'duration' + property :impressions, :numeric_string => true, 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::DfareportingV3_4::City, decorator: Google::Apis::DfareportingV3_4::City::Representation + + collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_4::Country, decorator: Google::Apis::DfareportingV3_4::Country::Representation + + property :exclude_countries, as: 'excludeCountries' + collection :metros, as: 'metros', class: Google::Apis::DfareportingV3_4::Metro, decorator: Google::Apis::DfareportingV3_4::Metro::Representation + + collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV3_4::PostalCode, decorator: Google::Apis::DfareportingV3_4::PostalCode::Representation + + collection :regions, as: 'regions', class: Google::Apis::DfareportingV3_4::Region, decorator: Google::Apis::DfareportingV3_4::Region::Representation + + end + end + + class InsertEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cm_dimensions, as: 'cmDimensions', class: Google::Apis::DfareportingV3_4::CampaignManagerIds, decorator: Google::Apis::DfareportingV3_4::CampaignManagerIds::Representation + + property :dv3_dimensions, as: 'dv3Dimensions', class: Google::Apis::DfareportingV3_4::Dv3Ids, decorator: Google::Apis::DfareportingV3_4::Dv3Ids::Representation + + property :insert_event_type, as: 'insertEventType' + property :kind, as: 'kind' + property :match_id, as: 'matchId' + property :mobile_device_id, as: 'mobileDeviceId' + end + end + + class InventoryItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + collection :ad_slots, as: 'adSlots', class: Google::Apis::DfareportingV3_4::AdSlot, decorator: Google::Apis::DfareportingV3_4::AdSlot::Representation + + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :estimated_click_through_rate, :numeric_string => true, as: 'estimatedClickThroughRate' + property :estimated_conversion_rate, :numeric_string => true, as: 'estimatedConversionRate' + property :id, :numeric_string => true, as: 'id' + property :in_plan, as: 'inPlan' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + property :negotiation_channel_id, :numeric_string => true, as: 'negotiationChannelId' + property :order_id, :numeric_string => true, as: 'orderId' + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing, as: 'pricing', class: Google::Apis::DfareportingV3_4::Pricing, decorator: Google::Apis::DfareportingV3_4::Pricing::Representation + + property :project_id, :numeric_string => true, as: 'projectId' + property :rfp_id, :numeric_string => true, as: 'rfpId' + property :site_id, :numeric_string => true, as: 'siteId' + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::InventoryItem, decorator: Google::Apis::DfareportingV3_4::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 :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :archived, as: 'archived' + collection :deep_links, as: 'deepLinks', class: Google::Apis::DfareportingV3_4::DeepLink, decorator: Google::Apis::DfareportingV3_4::DeepLink::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :url, as: 'url' + end + end + + class Language + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::Language, decorator: Google::Apis::DfareportingV3_4::Language::Representation + + end + end + + class LanguagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :languages, as: 'languages', class: Google::Apis::DfareportingV3_4::Language, decorator: Google::Apis::DfareportingV3_4::Language::Representation + + end + end + + class LastModifiedInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :time, :numeric_string => true, as: 'time' + end + end + + class ListPopulationClause + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :terms, as: 'terms', class: Google::Apis::DfareportingV3_4::ListPopulationTerm, decorator: Google::Apis::DfareportingV3_4::ListPopulationTerm::Representation + + end + end + + class ListPopulationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_activity_name, as: 'floodlightActivityName' + collection :list_population_clauses, as: 'listPopulationClauses', class: Google::Apis::DfareportingV3_4::ListPopulationClause, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, 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, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :dma_id, :numeric_string => true, 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::DfareportingV3_4::Metro, decorator: Google::Apis::DfareportingV3_4::Metro::Representation + + end + end + + class MobileApp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :directory, as: 'directory' + property :id, as: 'id' + property :kind, as: 'kind' + property :publisher_name, as: 'publisherName' + property :title, as: 'title' + end + end + + class MobileAppsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :mobile_apps, as: 'mobileApps', class: Google::Apis::DfareportingV3_4::MobileApp, decorator: Google::Apis::DfareportingV3_4::MobileApp::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class MobileCarrier + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :id, :numeric_string => true, 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::DfareportingV3_4::MobileCarrier, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, 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, :numeric_string => true, 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::DfareportingV3_4::OperatingSystem, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystem, decorator: Google::Apis::DfareportingV3_4::OperatingSystem::Representation + + end + end + + class OptimizationActivity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_activity_id_dimension_value, as: 'floodlightActivityIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :weight, as: 'weight' + end + end + + class Order + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, 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::DfareportingV3_4::OrderContact, decorator: Google::Apis::DfareportingV3_4::OrderContact::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + property :notes, as: 'notes' + property :planning_term_id, :numeric_string => true, as: 'planningTermId' + property :project_id, :numeric_string => true, 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, :numeric_string => true, 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, :numeric_string => true, as: 'signatureUserProfileId' + end + end + + class OrderDocument + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :amended_order_document_id, :numeric_string => true, as: 'amendedOrderDocumentId' + collection :approved_by_user_profile_ids, as: 'approvedByUserProfileIds' + property :cancelled, as: 'cancelled' + property :created_info, as: 'createdInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :effective_date, as: 'effectiveDate', type: Date + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + collection :last_sent_recipients, as: 'lastSentRecipients' + property :last_sent_time, as: 'lastSentTime', type: DateTime + + property :order_id, :numeric_string => true, as: 'orderId' + property :project_id, :numeric_string => true, as: 'projectId' + property :signed, as: 'signed' + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::OrderDocument, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Order, decorator: Google::Apis::DfareportingV3_4::Order::Representation + + end + end + + class PathToConversionReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + end + end + + class Placement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :ad_blocking_opt_out, as: 'adBlockingOptOut' + collection :additional_sizes, as: 'additionalSizes', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_4::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_4::LookbackConfiguration::Representation + + property :name, as: 'name' + property :payment_approved, as: 'paymentApproved' + property :payment_source, as: 'paymentSource' + property :placement_group_id, :numeric_string => true, as: 'placementGroupId' + property :placement_group_id_dimension_value, as: 'placementGroupIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_4::PricingSchedule, decorator: Google::Apis::DfareportingV3_4::PricingSchedule::Representation + + property :primary, as: 'primary' + property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :ssl_required, as: 'sslRequired' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + collection :tag_formats, as: 'tagFormats' + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_4::TagSetting, decorator: Google::Apis::DfareportingV3_4::TagSetting::Representation + + property :video_active_view_opt_out, as: 'videoActiveViewOptOut' + property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV3_4::VideoSettings, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'placementId' + property :placement_id_dimension_value, as: 'placementIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :ssl_required, as: 'sslRequired' + end + end + + class PlacementGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :child_placement_ids, as: 'childPlacementIds' + property :comment, as: 'comment' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + property :placement_group_type, as: 'placementGroupType' + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_4::PricingSchedule, decorator: Google::Apis::DfareportingV3_4::PricingSchedule::Representation + + property :primary_placement_id, :numeric_string => true, as: 'primaryPlacementId' + property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::PlacementGroup, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategy, decorator: Google::Apis::DfareportingV3_4::PlacementStrategy::Representation + + end + end + + class PlacementStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class PlacementTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :placement_id, :numeric_string => true, as: 'placementId' + collection :tag_datas, as: 'tagDatas', class: Google::Apis::DfareportingV3_4::TagData, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementTag, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Placement, decorator: Google::Apis::DfareportingV3_4::Placement::Representation + + end + end + + class PlatformType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::PlatformType, decorator: Google::Apis::DfareportingV3_4::PlatformType::Representation + + end + end + + class PopupWindowProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension, as: 'dimension', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :offset, as: 'offset', class: Google::Apis::DfareportingV3_4::OffsetPosition, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, 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::DfareportingV3_4::PostalCode, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Flight, decorator: Google::Apis::DfareportingV3_4::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 :end_date, as: 'endDate', type: Date + + property :flighted, as: 'flighted' + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + collection :pricing_periods, as: 'pricingPeriods', class: Google::Apis::DfareportingV3_4::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'rateOrCostNanos' + property :start_date, as: 'startDate', type: Date + + property :units, :numeric_string => true, as: 'units' + end + end + + class Project + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :audience_age_group, as: 'audienceAgeGroup' + property :audience_gender, as: 'audienceGender' + property :budget, :numeric_string => true, as: 'budget' + property :client_billing_code, as: 'clientBillingCode' + property :client_name, as: 'clientName' + property :end_date, as: 'endDate', type: Date + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_4::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_4::LastModifiedInfo::Representation + + property :name, as: 'name' + property :overview, as: 'overview' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :target_clicks, :numeric_string => true, as: 'targetClicks' + property :target_conversions, :numeric_string => true, as: 'targetConversions' + property :target_cpa_nanos, :numeric_string => true, as: 'targetCpaNanos' + property :target_cpc_nanos, :numeric_string => true, as: 'targetCpcNanos' + property :target_cpm_active_view_nanos, :numeric_string => true, as: 'targetCpmActiveViewNanos' + property :target_cpm_nanos, :numeric_string => true, as: 'targetCpmNanos' + property :target_impressions, :numeric_string => true, 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::DfareportingV3_4::Project, decorator: Google::Apis::DfareportingV3_4::Project::Representation + + end + end + + class ReachReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, 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::DfareportingV3_4::Region, decorator: Google::Apis::DfareportingV3_4::Region::Representation + + end + end + + class RemarketingList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :life_span, :numeric_string => true, as: 'lifeSpan' + property :list_population_rule, as: 'listPopulationRule', class: Google::Apis::DfareportingV3_4::ListPopulationRule, decorator: Google::Apis::DfareportingV3_4::ListPopulationRule::Representation + + property :list_size, :numeric_string => true, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class RemarketingListShare + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :remarketing_list_id, :numeric_string => true, 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::DfareportingV3_4::RemarketingList, decorator: Google::Apis::DfareportingV3_4::RemarketingList::Representation + + end + end + + class Report + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :criteria, as: 'criteria', class: Google::Apis::DfareportingV3_4::Report::Criteria, decorator: Google::Apis::DfareportingV3_4::Report::Criteria::Representation + + property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV3_4::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV3_4::Report::CrossDimensionReachCriteria::Representation + + property :delivery, as: 'delivery', class: Google::Apis::DfareportingV3_4::Report::Delivery, decorator: Google::Apis::DfareportingV3_4::Report::Delivery::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV3_4::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV3_4::Report::FloodlightCriteria::Representation + + property :format, as: 'format' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' + property :name, as: 'name' + property :owner_profile_id, :numeric_string => true, as: 'ownerProfileId' + property :path_to_conversion_criteria, as: 'pathToConversionCriteria', class: Google::Apis::DfareportingV3_4::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV3_4::Report::PathToConversionCriteria::Representation + + property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV3_4::Report::ReachCriteria, decorator: Google::Apis::DfareportingV3_4::Report::ReachCriteria::Representation + + property :schedule, as: 'schedule', class: Google::Apis::DfareportingV3_4::Report::Schedule, decorator: Google::Apis::DfareportingV3_4::Report::Schedule::Representation + + property :sub_account_id, :numeric_string => true, as: 'subAccountId' + property :type, as: 'type' + end + + class Criteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activities, as: 'activities', class: Google::Apis::DfareportingV3_4::Activities, decorator: Google::Apis::DfareportingV3_4::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_4::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_4::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::SortedDimension::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + property :dimension, as: 'dimension' + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Recipient, decorator: Google::Apis::DfareportingV3_4::Recipient::Representation + + end + end + + class FloodlightCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::SortedDimension::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_4::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::SortedDimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::SortedDimension::Representation + + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::SortedDimension::Representation + + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_4::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Activities, decorator: Google::Apis::DfareportingV3_4::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_4::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_4::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_4::DateRange, decorator: Google::Apis::DfareportingV3_4::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::SortedDimension, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_4::Dimension, decorator: Google::Apis::DfareportingV3_4::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_4::Metric, decorator: Google::Apis::DfareportingV3_4::Metric::Representation + + end + end + + class ReportList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV3_4::Report, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_4::LookbackConfiguration::Representation + + property :report_generation_time_zone_id, :numeric_string => true, as: 'reportGenerationTimeZoneId' + end + end + + class RichMediaExitOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_4::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_4::ClickThroughUrl::Representation + + property :enabled, as: 'enabled' + property :exit_id, :numeric_string => true, as: 'exitId' + end + end + + class Rule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset_id, :numeric_string => true, as: 'assetId' + property :name, as: 'name' + property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' + end + end + + class Site + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :approved, as: 'approved' + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :name, as: 'name' + collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV3_4::SiteContact, decorator: Google::Apis::DfareportingV3_4::SiteContact::Representation + + property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV3_4::SiteSettings, decorator: Google::Apis::DfareportingV3_4::SiteSettings::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV3_4::SiteVideoSettings, decorator: Google::Apis::DfareportingV3_4::SiteVideoSettings::Representation + + end + end + + class SiteCompanionSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companions_disabled, as: 'companionsDisabled' + collection :enabled_sizes, as: 'enabledSizes', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :image_only, as: 'imageOnly' + property :kind, as: 'kind' + 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, :numeric_string => true, 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 :ad_blocking_opt_out, as: 'adBlockingOptOut' + property :disable_new_cookie, as: 'disableNewCookie' + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_4::TagSetting, decorator: Google::Apis::DfareportingV3_4::TagSetting::Representation + + property :video_active_view_opt_out_template, as: 'videoActiveViewOptOutTemplate' + property :vpaid_adapter_choice_template, as: 'vpaidAdapterChoiceTemplate' + end + end + + class SiteSkippableSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation + + property :skippable, as: 'skippable' + end + end + + class SiteTranscodeSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :enabled_video_formats, as: 'enabledVideoFormats' + property :kind, as: 'kind' + end + end + + class SiteVideoSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companion_settings, as: 'companionSettings', class: Google::Apis::DfareportingV3_4::SiteCompanionSetting, decorator: Google::Apis::DfareportingV3_4::SiteCompanionSetting::Representation + + property :kind, as: 'kind' + property :orientation, as: 'orientation' + property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV3_4::SiteSkippableSetting, decorator: Google::Apis::DfareportingV3_4::SiteSkippableSetting::Representation + + property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV3_4::SiteTranscodeSetting, decorator: Google::Apis::DfareportingV3_4::SiteTranscodeSetting::Representation + + 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::DfareportingV3_4::Site, decorator: Google::Apis::DfareportingV3_4::Site::Representation + + end + end + + class Size + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height, as: 'height' + property :iab, as: 'iab' + property :id, :numeric_string => true, 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::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::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, :numeric_string => true, as: 'accountId' + collection :available_permission_ids, as: 'availablePermissionIds' + property :id, :numeric_string => true, 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::DfareportingV3_4::Subaccount, decorator: Google::Apis::DfareportingV3_4::Subaccount::Representation + + end + end + + class TagData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ad_id, :numeric_string => true, as: 'adId' + property :click_tag, as: 'clickTag' + property :creative_id, :numeric_string => true, 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, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :life_span, :numeric_string => true, as: 'lifeSpan' + property :list_size, :numeric_string => true, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, 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::DfareportingV3_4::TargetableRemarketingList, decorator: Google::Apis::DfareportingV3_4::TargetableRemarketingList::Representation + + end + end + + class TargetingTemplate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_4::DayPartTargeting, decorator: Google::Apis::DfareportingV3_4::DayPartTargeting::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_4::GeoTargeting, decorator: Google::Apis::DfareportingV3_4::GeoTargeting::Representation + + property :id, :numeric_string => true, as: 'id' + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_4::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_4::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_4::LanguageTargeting, decorator: Google::Apis::DfareportingV3_4::LanguageTargeting::Representation + + property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV3_4::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_4::ListTargetingExpression::Representation + + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_4::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplate, decorator: Google::Apis::DfareportingV3_4::TargetingTemplate::Representation + + end + end + + class TechnologyTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV3_4::Browser, decorator: Google::Apis::DfareportingV3_4::Browser::Representation + + collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV3_4::ConnectionType, decorator: Google::Apis::DfareportingV3_4::ConnectionType::Representation + + collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV3_4::MobileCarrier, decorator: Google::Apis::DfareportingV3_4::MobileCarrier::Representation + + collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV3_4::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_4::OperatingSystemVersion::Representation + + collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV3_4::OperatingSystem, decorator: Google::Apis::DfareportingV3_4::OperatingSystem::Representation + + collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV3_4::PlatformType, decorator: Google::Apis::DfareportingV3_4::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 UniversalAdId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :registry, as: 'registry' + property :value, as: 'value' + 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, :numeric_string => true, as: 'accountId' + property :account_name, as: 'accountName' + property :etag, as: 'etag' + property :kind, as: 'kind' + property :profile_id, :numeric_string => true, as: 'profileId' + property :sub_account_id, :numeric_string => true, 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::DfareportingV3_4::UserProfile, decorator: Google::Apis::DfareportingV3_4::UserProfile::Representation + + property :kind, as: 'kind' + end + end + + class UserRole + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :default_user_role, as: 'defaultUserRole' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :parent_user_role_id, :numeric_string => true, as: 'parentUserRoleId' + collection :permissions, as: 'permissions', class: Google::Apis::DfareportingV3_4::UserRolePermission, decorator: Google::Apis::DfareportingV3_4::UserRolePermission::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class UserRolePermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :availability, as: 'availability' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' + end + end + + class UserRolePermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, 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::DfareportingV3_4::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolePermission, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRole, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::VideoFormat, decorator: Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CompanionSetting, decorator: Google::Apis::DfareportingV3_4::CompanionSetting::Representation + + property :kind, as: 'kind' + property :orientation, as: 'orientation' + property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV3_4::SkippableSetting, decorator: Google::Apis::DfareportingV3_4::SkippableSetting::Representation + + property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV3_4::TranscodeSetting, decorator: Google::Apis::DfareportingV3_4::TranscodeSetting::Representation + + end + end + end + end +end diff --git a/generated/google/apis/dfareporting_v3_4/service.rb b/generated/google/apis/dfareporting_v3_4/service.rb new file mode 100644 index 000000000..22727295e --- /dev/null +++ b/generated/google/apis/dfareporting_v3_4/service.rb @@ -0,0 +1,8685 @@ +# 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 DfareportingV3_4 + # DCM/DFA Reporting And Trafficking API + # + # Manages your DoubleClick Campaign Manager ad campaigns and reports. + # + # @example + # require 'google/apis/dfareporting_v3_4' + # + # Dfareporting = Google::Apis::DfareportingV3_4 # 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] + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + attr_accessor :quota_user + + # @return [String] + # Deprecated. Please use quotaUser instead. + attr_accessor :user_ip + + def initialize + super('https://www.googleapis.com/', 'dfareporting/v3.4/') + @batch_path = 'batch/dfareporting/v3.4' + end + + # Gets the account's active ad summary by account ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] summary_account_id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountActiveAdSummary] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountActiveAdSummary::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountPermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountPermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountPermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountPermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountPermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountPermission::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountPermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountPermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active user profiles. + # @param [Array, Fixnum] 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. + # @param [Fixnum] subaccount_id + # Select only user profiles with the specified subaccount ID. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountUserProfilesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountUserProfilesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User profile ID. + # @param [Google::Apis::DfareportingV3_4::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_4::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Account::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account ID. + # @param [Google::Apis::DfareportingV3_4::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV3_4::Account::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV3_4::Account::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Ad ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active ads. + # @param [Fixnum] advertiser_id + # Select only ads with this advertiser ID. + # @param [Boolean] archived + # Select only archived ads. + # @param [Array, Fixnum] audience_segment_ids + # Select only ads with these audience segment IDs. + # @param [Array, Fixnum] 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, Fixnum] creative_ids + # Select only ads with these creative IDs assigned. + # @param [Array, Fixnum] 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, Fixnum] ids + # Select only ads with these IDs. + # @param [Array, Fixnum] landing_page_ids + # Select only ads with these landing page IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Fixnum] 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, Fixnum] placement_ids + # Select only ads with these placement IDs assigned. + # @param [Array, Fixnum] 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, Fixnum] 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. + # @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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Ad ID. + # @param [Google::Apis::DfareportingV3_4::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_4::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertiserGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [Google::Apis::DfareportingV3_4::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 landing page by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Landing page ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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_advertiser_landing_page(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_4::LandingPage + 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 landing page. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_4::LandingPage + 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 landing pages. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only landing pages that belong to these advertisers. + # @param [Boolean] archived + # Select only archived landing pages. Don't set this field to select both + # archived and non-archived landing pages. + # @param [Array, Fixnum] campaign_ids + # Select only landing pages that are associated with these campaigns. + # @param [Array, Fixnum] ids + # Select only landing pages 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 landing pages by name or ID. Wildcards (*) are allowed. + # For example, "landingpage*2017" will return landing pages with names like " + # landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". + # Most of the searches also add wildcards implicitly at the start and the end + # of the search string. For example, a search string of "landingpage" will match + # campaigns with name "my landingpage", "landingpage 2015", or simply " + # landingpage". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only landing pages that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_pages(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: 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}/advertiserLandingPages', options) + command.response_representation = Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::AdvertiserLandingPagesListResponse + 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['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 landing page. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Landing page ID. + # @param [Google::Apis::DfareportingV3_4::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_4::LandingPage + 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 landing page. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_4::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_4::LandingPage + 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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_group_ids + # Select only advertisers with these advertiser group IDs. + # @param [Array, Fixnum] floodlight_configuration_ids + # Select only advertisers with these floodlight configuration IDs. + # @param [Array, Fixnum] 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. + # @param [String] status + # Select only advertisers with the specified status. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::AdvertisersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::AdvertisersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser ID. + # @param [Google::Apis::DfareportingV3_4::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_4::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::BrowsersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::BrowsersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] campaign_id + # Campaign ID in this association. + # @param [Google::Apis::DfareportingV3_4::CampaignCreativeAssociation] campaign_creative_association_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CampaignCreativeAssociation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CampaignCreativeAssociation::Representation + command.request_object = campaign_creative_association_object + command.response_representation = Google::Apis::DfareportingV3_4::CampaignCreativeAssociation::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CampaignCreativeAssociationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CampaignCreativeAssociationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Campaign ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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, 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::DfareportingV3_4::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + + # Retrieves a list of campaigns, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_group_ids + # Select only campaigns whose advertisers belong to these advertiser groups. + # @param [Array, Fixnum] 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, Fixnum] excluded_ids + # Exclude campaigns with these IDs. + # @param [Array, Fixnum] ids + # Select only campaigns with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Fixnum] 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. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CampaignsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CampaignsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Campaign ID. + # @param [Google::Apis::DfareportingV3_4::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_4::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Change log ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ChangeLog] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ChangeLog::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] action + # Select only change logs with the specified action. + # @param [Array, Fixnum] 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 after 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, Fixnum] 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, Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ChangeLogsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ChangeLogsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] country_dart_ids + # Select only cities from these countries. + # @param [Array, Fixnum] dart_ids + # Select only cities with these DART IDs. + # @param [String] name_prefix + # Select only cities with names starting with this prefix. + # @param [Array, Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Connection type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ConnectionType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ConnectionType::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ConnectionTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ConnectionTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ContentCategoriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategoriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [Google::Apis::DfareportingV3_4::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_4::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::ConversionsBatchInsertRequest] conversions_batch_insert_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ConversionsBatchInsertResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ConversionsBatchInsertRequest::Representation + command.request_object = conversions_batch_insert_request_object + command.response_representation = Google::Apis::DfareportingV3_4::ConversionsBatchInsertResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + + # Updates existing conversions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::ConversionsBatchUpdateRequest] conversions_batch_update_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchupdate', options) + command.request_representation = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateRequest::Representation + command.request_object = conversions_batch_update_request_object + command.response_representation = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::ConversionsBatchUpdateResponse + 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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] dart_id + # Country DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Country] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Country::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CountriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CountriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Advertiser ID of this creative. This is a required field. + # @param [Google::Apis::DfareportingV3_4::CreativeAssetMetadata] creative_asset_metadata_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [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::DfareportingV3_4::CreativeAssetMetadata] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeAssetMetadata::Representation + command.request_object = creative_asset_metadata_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeAssetMetadata::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV3_4::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldValuesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldValuesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [Google::Apis::DfareportingV3_4::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV3_4::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only creative fields that belong to these advertisers. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeFieldsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeFieldsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [Google::Apis::DfareportingV3_4::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative group ID. + # @param [Google::Apis::DfareportingV3_4::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_4::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 [Fixnum] 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 [Fixnum] campaign_id + # Select only creatives with this campaign ID. + # @param [Array, Fixnum] companion_creative_ids + # Select only in-stream video creatives with these companion IDs. + # @param [Array, Fixnum] creative_field_ids + # Select only creatives with these creative field IDs. + # @param [Array, Fixnum] 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, Fixnum] 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, Fixnum] 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. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CreativesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::CreativesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative ID. + # @param [Google::Apis::DfareportingV3_4::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_4::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + + # Inserts custom events. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::CustomEventsBatchInsertRequest] custom_events_batch_insert_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_custom_event(profile_id, custom_events_batch_insert_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/customEvents/batchinsert', options) + command.request_representation = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertRequest::Representation + command.request_object = custom_events_batch_insert_request_object + command.response_representation = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::CustomEventsBatchInsertResponse + 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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_4::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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DimensionValueList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DimensionValueRequest::Representation + command.request_object = dimension_value_request_object + command.response_representation = Google::Apis::DfareportingV3_4::DimensionValueList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Directory site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::DirectorySite] directory_site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DirectorySite::Representation + command.request_object = directory_site_object + command.response_representation = Google::Apis::DfareportingV3_4::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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] dfp_network_code + # Select only directory sites with this Ad Manager network code. + # @param [Array, Fixnum] 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] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DirectorySitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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, dfp_network_code: 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}/directorySites', options) + command.response_representation = Google::Apis::DfareportingV3_4::DirectorySitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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['dfpNetworkCode'] = 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['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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::DynamicTargetingKey] dynamic_targeting_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DynamicTargetingKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DynamicTargetingKey::Representation + command.request_object = dynamic_targeting_key_object + command.response_representation = Google::Apis::DfareportingV3_4::DynamicTargetingKey::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::DynamicTargetingKeysListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::DynamicTargetingKeysListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] ad_id + # Select only event tags that belong to this ad. + # @param [Fixnum] advertiser_id + # Select only event tags that belong to this advertiser. + # @param [Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::EventTagsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::EventTagsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [Google::Apis::DfareportingV3_4::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_4::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_4::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. This method supports + # media download. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [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::DfareportingV3_4::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::File::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FileList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivitiesGenerateTagResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivitiesGenerateTagResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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, Fixnum] 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 [Fixnum] 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, Fixnum] 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. + # @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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity Group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only floodlight activity groups with the specified advertiser ID. Must + # specify either advertiserId or floodlightConfigurationId for a non-empty + # result. + # @param [Fixnum] 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, Fixnum] 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. + # @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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivityGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivityGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity Group ID. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight configuration ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightConfigurationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightConfigurationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight configuration ID. + # @param [Google::Apis::DfareportingV3_4::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV3_4::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Fixnum] id + # Inventory item ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::InventoryItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::InventoryItem::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Array, Fixnum] 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, Fixnum] 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, Fixnum] 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. + # @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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::InventoryItemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::InventoryItemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + + # Retrieves a list of languages. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::LanguagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::LanguagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::MetrosListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::MetrosListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 app by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] id + # Mobile app ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::MobileApp] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::MobileApp] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_app(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileApps/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_4::MobileApp::Representation + command.response_class = Google::Apis::DfareportingV3_4::MobileApp + 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 list of available mobile apps. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, String] directories + # Select only apps from these directories. + # @param [Array, String] ids + # Select only apps 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, "app*2015" will return objects with names like "app Jan 2018", "app + # Jan 2018", or simply "app 2018". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "app" will match objects with name "my app", "app 2018", or + # simply "app". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::MobileAppsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::MobileAppsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_apps(profile_id, directories: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileApps', options) + command.response_representation = Google::Apis::DfareportingV3_4::MobileAppsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::MobileAppsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['directories'] = directories unless directories.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['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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Mobile carrier ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::MobileCarrier] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::MobileCarrier::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::MobileCarriersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::MobileCarriersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Operating system version ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OperatingSystemVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystemVersion::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OperatingSystemVersionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystemVersionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] dart_id + # Operating system DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OperatingSystem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystem::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OperatingSystemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OperatingSystemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Fixnum] id + # Order document ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OrderDocument] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OrderDocument::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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, Fixnum] ids + # Select only order documents with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Array, Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OrderDocumentsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OrderDocumentsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for orders. + # @param [Fixnum] id + # Order ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Order] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Order::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for orders. + # @param [Array, Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::OrdersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::OrdersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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, Fixnum] campaign_ids + # Select only placement groups that belong to these campaigns. + # @param [Array, Fixnum] content_category_ids + # Select only placement groups that are associated with these content categories. + # @param [Array, Fixnum] directory_site_ids + # Select only placement groups that are associated with these directory sites. + # @param [Array, Fixnum] 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, Fixnum] 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, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement group ID. + # @param [Google::Apis::DfareportingV3_4::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementStrategiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [Google::Apis::DfareportingV3_4::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_4::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] campaign_id + # Generate placements belonging to this campaign. This is a required field. + # @param [Array, Fixnum] placement_ids + # Generate tags for these placements. + # @param [Array, String] tag_formats + # Tag formats to generate for these placements. + # Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementsGenerateTagsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementsGenerateTagsResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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, Fixnum] 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, Fixnum] content_category_ids + # Select only placements that are associated with these content categories. + # @param [Array, Fixnum] directory_site_ids + # Select only placements that are associated with these directory sites. + # @param [Array, Fixnum] group_ids + # Select only placements that belong to these placement groups. + # @param [Array, Fixnum] 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, Fixnum] 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, Fixnum] site_ids + # Select only placements that are associated with these sites. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlacementsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlacementsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement ID. + # @param [Google::Apis::DfareportingV3_4::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_4::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Platform type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlatformType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlatformType::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PlatformTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PlatformTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PostalCode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PostalCode::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::PostalCodesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::PostalCodesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Project ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Project] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Project::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only projects with these advertiser IDs. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ProjectsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ProjectsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RegionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RegionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] remarketing_list_id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] remarketing_list_id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV3_4::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV3_4::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only remarketing lists owned by this advertiser. + # @param [Boolean] active + # Select only active or only inactive remarketing lists. + # @param [Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV3_4::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_4::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Report::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_4::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::ReportList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::ReportList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + + # Runs a report. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::File::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Google::Apis::DfareportingV3_4::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_4::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::CompatibleFields] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_4::CompatibleFields::Representation + command.response_class = Google::Apis::DfareportingV3_4::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. This method supports media download. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [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::DfareportingV3_4::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::File::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::FileList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Site::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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, Fixnum] campaign_ids + # Select only sites with these campaign IDs. + # @param [Array, Fixnum] directory_site_ids + # Select only sites with these directory site IDs. + # @param [Array, Fixnum] 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. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::SitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::SitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Site ID. + # @param [Google::Apis::DfareportingV3_4::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_4::Site::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Size ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Size::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Size] size_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Size::Representation + command.request_object = size_object + command.response_representation = Google::Apis::DfareportingV3_4::Size::Representation + command.response_class = Google::Apis::DfareportingV3_4::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. Retrieved sizes are globally + # unique and may include values not currently in use by your account. Due to + # this, the list of sizes returned by this method may differ from the list seen + # in the Trafficking UI. + # @param [Fixnum] 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, Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::SizesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::SizesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Subaccount ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::SubaccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::SubaccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Subaccount ID. + # @param [Google::Apis::DfareportingV3_4::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_4::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetableRemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetableRemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetableRemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetableRemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Targeting template ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only targeting templates with this advertiser ID. + # @param [Array, Fixnum] 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetingTemplatesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplatesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Targeting template ID. + # @param [Google::Apis::DfareportingV3_4::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_4::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # The user profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserProfileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserProfileList::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRolePermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolePermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRolePermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolePermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRolePermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolePermission::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRolePermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolePermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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, Fixnum] 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. + # @param [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRolesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRolesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [Google::Apis::DfareportingV3_4::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_4::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_4::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::VideoFormat] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::VideoFormat::Representation + command.response_class = Google::Apis::DfareportingV3_4::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 [Fixnum] 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 + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_4::VideoFormatsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_4::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::DfareportingV3_4::VideoFormatsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_4::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/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index 298df4f12..9320becf9 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20191111' + REVISION = '20191118' # 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/dlp_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index 1c3972aa6..f48da9de5 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -1058,7 +1058,7 @@ module Google class GooglePrivacyDlpV2CreateDeidentifyTemplateRequest include Google::Apis::Core::Hashable - # The DeidentifyTemplates contains instructions on how to deidentify content. + # DeidentifyTemplates contains instructions on how to de-identify content. # See https://cloud.google.com/dlp/docs/concepts-templates to learn more. # Corresponds to the JSON property `deidentifyTemplate` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate] @@ -1212,7 +1212,9 @@ module Google class GooglePrivacyDlpV2CreateStoredInfoTypeRequest include Google::Apis::Core::Hashable - # Configuration for a StoredInfoType. + # Configuration for stored infoT types. All fields and subfield are provided + # by the user. For more information, see + # https://cloud.google.com/dlp/docs/creating-custom-infotypes. # Corresponds to the JSON property `config` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2StoredInfoTypeConfig] attr_accessor :config @@ -1776,12 +1778,12 @@ module Google end end - # The DeidentifyTemplates contains instructions on how to deidentify content. + # DeidentifyTemplates contains instructions on how to de-identify content. # See https://cloud.google.com/dlp/docs/concepts-templates to learn more. class GooglePrivacyDlpV2DeidentifyTemplate include Google::Apis::Core::Hashable - # The creation timestamp of a inspectTemplate, output only field. + # The creation timestamp of an inspectTemplate, output only field. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -1809,7 +1811,7 @@ module Google # @return [String] attr_accessor :name - # The last update timestamp of a inspectTemplate, output only field. + # The last update timestamp of an inspectTemplate, output only field. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -3065,7 +3067,7 @@ module Google class GooglePrivacyDlpV2InspectTemplate include Google::Apis::Core::Hashable - # The creation timestamp of a inspectTemplate, output only field. + # The creation timestamp of an inspectTemplate, output only field. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -3095,7 +3097,7 @@ module Google # @return [String] attr_accessor :name - # The last update timestamp of a inspectTemplate, output only field. + # The last update timestamp of an inspectTemplate, output only field. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -5285,7 +5287,9 @@ module Google end end - # Configuration for a StoredInfoType. + # Configuration for stored infoT types. All fields and subfield are provided + # by the user. For more information, see + # https://cloud.google.com/dlp/docs/creating-custom-infotypes. class GooglePrivacyDlpV2StoredInfoTypeConfig include Google::Apis::Core::Hashable @@ -5345,7 +5349,9 @@ module Google class GooglePrivacyDlpV2StoredInfoTypeVersion include Google::Apis::Core::Hashable - # Configuration for a StoredInfoType. + # Configuration for stored infoT types. All fields and subfield are provided + # by the user. For more information, see + # https://cloud.google.com/dlp/docs/creating-custom-infotypes. # Corresponds to the JSON property `config` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2StoredInfoTypeConfig] attr_accessor :config @@ -5806,7 +5812,7 @@ module Google class GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest include Google::Apis::Core::Hashable - # The DeidentifyTemplates contains instructions on how to deidentify content. + # DeidentifyTemplates contains instructions on how to de-identify content. # See https://cloud.google.com/dlp/docs/concepts-templates to learn more. # Corresponds to the JSON property `deidentifyTemplate` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate] @@ -5886,7 +5892,9 @@ module Google class GooglePrivacyDlpV2UpdateStoredInfoTypeRequest include Google::Apis::Core::Hashable - # Configuration for a StoredInfoType. + # Configuration for stored infoT types. All fields and subfield are provided + # by the user. For more information, see + # https://cloud.google.com/dlp/docs/creating-custom-infotypes. # Corresponds to the JSON property `config` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2StoredInfoTypeConfig] attr_accessor :config diff --git a/generated/google/apis/doubleclickbidmanager_v1_1.rb b/generated/google/apis/doubleclickbidmanager_v1_1.rb index a141d8e1b..8efb932c4 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1_1 VERSION = 'V1_1' - REVISION = '20191107' + REVISION = '20191112' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/drive_v3.rb b/generated/google/apis/drive_v3.rb index 4616a99eb..d981c417e 100644 --- a/generated/google/apis/drive_v3.rb +++ b/generated/google/apis/drive_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV3 VERSION = 'V3' - REVISION = '20191017' + REVISION = '20191108' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v3/classes.rb b/generated/google/apis/drive_v3/classes.rb index b9b4dacd8..c3ff29d0b 100644 --- a/generated/google/apis/drive_v3/classes.rb +++ b/generated/google/apis/drive_v3/classes.rb @@ -1960,7 +1960,13 @@ module Google attr_accessor :deleted alias_method :deleted?, :deleted - # A displayable name for users, groups or domains. + # The "pretty" name of the value of the permission. The following is a list of + # examples for each type of permission: + # - user - User's full name, as defined for their Google account, such as "Joe + # Smith." + # - group - Name of the Google Group, such as "The Company Administrators." + # - domain - String domain name, such as "thecompany.com." + # - anyone - No displayName is present. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -1985,7 +1991,8 @@ module Google attr_accessor :expiration_time # The ID of this permission. This is a unique identifier for the grantee, and is - # published in User resources as permissionId. + # published in User resources as permissionId. IDs should be treated as opaque + # values. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2029,7 +2036,9 @@ module Google # - user # - group # - domain - # - anyone + # - anyone When creating a permission, if type is user or group, you must + # provide an emailAddress for the user or group. When type is domain, you must + # provide a domain. There isn't extra information required for a anyone type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index 029a8a2fc..4c825d57d 100644 --- a/generated/google/apis/firebasehosting_v1beta1.rb +++ b/generated/google/apis/firebasehosting_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1beta1 VERSION = 'V1beta1' - REVISION = '20191115' + REVISION = '20191122' # 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/firebasehosting_v1beta1/service.rb b/generated/google/apis/firebasehosting_v1beta1/service.rb index 1381ee947..feb65ee06 100644 --- a/generated/google/apis/firebasehosting_v1beta1/service.rb +++ b/generated/google/apis/firebasehosting_v1beta1/service.rb @@ -446,6 +446,11 @@ module Google # @param [String] parent # Required. The parent for which to list files, in the format: # sites/site-name + # @param [String] filter + # The filter string used to return a subset of versions in the response. + # Currently supported fields for filtering are: name, status, + # and create_time. Filter processing will be implemented in accordance + # with go/filtering. # @param [Fixnum] page_size # The maximum number of versions to return. The service may return fewer than # this value. @@ -470,11 +475,12 @@ 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_site_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_site_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/versions', options) command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse::Representation command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.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? diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index 8f82a5b3d..5d803978c 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -30,7 +30,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20191111' + REVISION = '20191118' # 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/remotebuildexecution_v2.rb b/generated/google/apis/remotebuildexecution_v2.rb index 264d8013e..493ffba5e 100644 --- a/generated/google/apis/remotebuildexecution_v2.rb +++ b/generated/google/apis/remotebuildexecution_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV2 VERSION = 'V2' - REVISION = '20191008' + REVISION = '20191119' # 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/remotebuildexecution_v2/classes.rb b/generated/google/apis/remotebuildexecution_v2/classes.rb index 05c6295be..8e3a0749e 100644 --- a/generated/google/apis/remotebuildexecution_v2/classes.rb +++ b/generated/google/apis/remotebuildexecution_v2/classes.rb @@ -2630,6 +2630,39 @@ module Google end end + # The request used for `UpdateInstance`. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest + include Google::Apis::Core::Hashable + + # Whether to enable Stackdriver logging for this instance. + # Corresponds to the JSON property `loggingEnabled` + # @return [Boolean] + attr_accessor :logging_enabled + alias_method :logging_enabled?, :logging_enabled + + # Name of the instance to update. + # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The fields to update. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) + @name = args[:name] if args.key?(:name) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + # The request used for UpdateWorkerPool. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/remotebuildexecution_v2/representations.rb b/generated/google/apis/remotebuildexecution_v2/representations.rb index 0c26a9469..4e1bd66f9 100644 --- a/generated/google/apis/remotebuildexecution_v2/representations.rb +++ b/generated/google/apis/remotebuildexecution_v2/representations.rb @@ -364,6 +364,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1029,6 +1035,15 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :logging_enabled, as: 'loggingEnabled' + property :name, as: 'name' + property :update_mask, as: 'updateMask' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 719746faa..5a9b96796 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/partner/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20191031' + REVISION = '20191116' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'