google-apis-dfareporting_v4 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d25f97223667c912a5660bfdeb366464146384273fc3e5ee6c00cc84dcc4da3
-  data.tar.gz: c7f13fbda12b3eb536d3b2dc9ffabfa7e47f1a8a486dbfef3f11197b48c1ffe6
+  metadata.gz: be60fccb468e73f0ffd70ea1cdbfe014c7fcd1820baf3a43ec43e9e16a016ac7
+  data.tar.gz: e3131550c6f081c4f5cd78192bc063f4f0be7d269b38b5d7def08da472018855
 SHA512:
-  metadata.gz: 6e501671558162026b0b485114cd1d73e57c5735651a9d0a7aae67e0819666b6f02875f9e9115af762cd5cec3f264f0a9e37c2227461f9a991e61a78d7b470ce
-  data.tar.gz: '08b2375a39480429d450a0ddaf1ae44f49d66c4e27c7542aa303a4eedca06e39a438291771d434b1b50144d9bab9b9ec069aee43cc10013162fd58e740a7adc8'
+  metadata.gz: 51d17f0c88cd7065bd20f19d7f4e654d463f6d731d5adcaf273687bdba8efd0606da739ea51064b233537f9bb94e9629ffa6cbe1912dda81c554ff70175d89c0
+  data.tar.gz: 2583f39dd9c6e5af7cf6e849cf62b28b60139e01a170a44a06eed4565067068e563cd327168b83bc2570189c73d51c0acfe590fb3ed90c25f42ac99687259326

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-dfareporting_v4
 
+### v0.10.0 (2023-08-06)
+
+* Regenerated from discovery document revision 20230726
+
+### v0.9.0 (2023-04-30)
+
+* Regenerated from discovery document revision 20230425
+
 ### v0.8.0 (2023-03-26)
 
 * Regenerated from discovery document revision 20230321

data/lib/google/apis/dfareporting_v4/classes.rb

@@ -313,7 +313,7 @@ module Google
         attr_accessor :account_permission_groups
       
         # Identifies what kind of resource this is. Value: the fixed string "
-        # dfareporting#accountPermissionGroupsListResponse".
+        # dfareporting#accountPermissionGroupGroupsListResponse".
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
@@ -2713,7 +2713,7 @@ module Google
         end
       end
       
-      # Organizes placements according to the contents of their associated webpages.
+      # 
       class ContentCategory
         include Google::Apis::Core::Hashable
       
@@ -2869,7 +2869,7 @@ module Google
         # @return [String]
         attr_accessor :ordinal
       
-        # The quantity of the conversion.
+        # The quantity of the conversion. This is a required field.
         # Corresponds to the JSON property `quantity`
         # @return [Fixnum]
         attr_accessor :quantity
@@ -2887,7 +2887,13 @@ module Google
         attr_accessor :treatment_for_underage
         alias_method :treatment_for_underage?, :treatment_for_underage
       
-        # The value of the conversion.
+        # The user identifiers to enhance the conversion. The maximum number of user
+        # identifiers for each conversion is 5.
+        # Corresponds to the JSON property `userIdentifiers`
+        # @return [Array<Google::Apis::DfareportingV4::UserIdentifier>]
+        attr_accessor :user_identifiers
+      
+        # The value of the conversion. This is a required field.
         # Corresponds to the JSON property `value`
         # @return [Float]
         attr_accessor :value
@@ -2916,6 +2922,7 @@ module Google
           @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)
+          @user_identifiers = args[:user_identifiers] if args.key?(:user_identifiers)
           @value = args[:value] if args.key?(:value)
         end
       end
@@ -3230,8 +3237,8 @@ module Google
         # @return [Array<Google::Apis::DfareportingV4::Size>]
         attr_accessor :additional_sizes
       
-        # Advertiser ID of this creative. This is a required field. Applicable to all
-        # creative types.
+        # Required. 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
@@ -3483,8 +3490,8 @@ module Google
         # @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.
+        # Required. Name of the creative. This must be less than 256 characters long.
+        # Applicable to all creative types.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -3633,10 +3640,9 @@ module Google
         # @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.
+        # Required. Type of this creative. 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
@@ -6784,8 +6790,7 @@ module Google
         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
@@ -7162,7 +7167,7 @@ module Google
         # @return [Fixnum]
         attr_accessor :placement_strategy_id
       
-        # Pricing Information
+        # Pricing of this inventory item.
         # Corresponds to the JSON property `pricing`
         # @return [Google::Apis::DfareportingV4::Pricing]
         attr_accessor :pricing
@@ -7755,7 +7760,7 @@ module Google
       class MeasurementPartnerAdvertiserLink
         include Google::Apis::Core::Hashable
       
-        # .
+        # Status of the partner link.
         # Corresponds to the JSON property `linkStatus`
         # @return [String]
         attr_accessor :link_status
@@ -7765,7 +7770,7 @@ module Google
         # @return [String]
         attr_accessor :measurement_partner
       
-        # .
+        # partner Advertiser Id.
         # Corresponds to the JSON property `partnerAdvertiserId`
         # @return [String]
         attr_accessor :partner_advertiser_id
@@ -7859,7 +7864,7 @@ module Google
         # @return [String]
         attr_accessor :kind
       
-        # The metric name, e.g. dfa:impressions
+        # The metric name, e.g. impressions
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -8202,6 +8207,64 @@ module Google
         end
       end
       
+      # Identify a user by name and address.
+      class OfflineUserAddressInfo
+        include Google::Apis::Core::Hashable
+      
+        # City of the address.
+        # Corresponds to the JSON property `city`
+        # @return [String]
+        attr_accessor :city
+      
+        # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
+        # Corresponds to the JSON property `countryCode`
+        # @return [String]
+        attr_accessor :country_code
+      
+        # First name of the user, which is hashed as SHA-256 after normalized (Lowercase
+        # all characters; Remove any extra spaces before, after, and in between).
+        # Corresponds to the JSON property `hashedFirstName`
+        # @return [String]
+        attr_accessor :hashed_first_name
+      
+        # Last name of the user, which is hashed as SHA-256 after normalized (lower case
+        # only and no punctuation).
+        # Corresponds to the JSON property `hashedLastName`
+        # @return [String]
+        attr_accessor :hashed_last_name
+      
+        # The street address of the user hashed using SHA-256 hash function after
+        # normalization (lower case only).
+        # Corresponds to the JSON property `hashedStreetAddress`
+        # @return [String]
+        attr_accessor :hashed_street_address
+      
+        # Postal code of the user's address.
+        # Corresponds to the JSON property `postalCode`
+        # @return [String]
+        attr_accessor :postal_code
+      
+        # State code of the address.
+        # Corresponds to the JSON property `state`
+        # @return [String]
+        attr_accessor :state
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @city = args[:city] if args.key?(:city)
+          @country_code = args[:country_code] if args.key?(:country_code)
+          @hashed_first_name = args[:hashed_first_name] if args.key?(:hashed_first_name)
+          @hashed_last_name = args[:hashed_last_name] if args.key?(:hashed_last_name)
+          @hashed_street_address = args[:hashed_street_address] if args.key?(:hashed_street_address)
+          @postal_code = args[:postal_code] if args.key?(:postal_code)
+          @state = args[:state] if args.key?(:state)
+        end
+      end
+      
       # Offset Position.
       class OffsetPosition
         include Google::Apis::Core::Hashable
@@ -8618,158 +8681,6 @@ module Google
         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<Fixnum>]
-        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::DfareportingV4::LastModifiedInfo]
-        attr_accessor :created_info
-      
-        # 
-        # 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<String>]
-        attr_accessor :last_sent_recipients
-      
-        # 
-        # 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<Google::Apis::DfareportingV4::OrderDocument>]
-        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
@@ -9916,7 +9827,7 @@ module Google
         end
       end
       
-      # Pricing Information
+      # 
       class Pricing
         include Google::Apis::Core::Hashable
       
@@ -10051,7 +9962,7 @@ module Google
         # @return [String]
         attr_accessor :pricing_comment
       
-        # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000).
+        # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000).
         # Acceptable values are 0 to 1000000000000000000, inclusive.
         # Corresponds to the JSON property `rateOrCostNanos`
         # @return [Fixnum]
@@ -12379,7 +12290,7 @@ module Google
       # 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 list to be used to facilitate 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
@@ -12842,6 +12753,38 @@ module Google
         end
       end
       
+      # User identifying information. Exactly one type of identifier must be specified.
+      class UserIdentifier
+        include Google::Apis::Core::Hashable
+      
+        # Identify a user by name and address.
+        # Corresponds to the JSON property `addressInfo`
+        # @return [Google::Apis::DfareportingV4::OfflineUserAddressInfo]
+        attr_accessor :address_info
+      
+        # Hashed email address using SHA-256 hash function after normalization.
+        # Corresponds to the JSON property `hashedEmail`
+        # @return [String]
+        attr_accessor :hashed_email
+      
+        # Hashed phone number using SHA-256 hash function after normalization (E164
+        # standard).
+        # Corresponds to the JSON property `hashedPhoneNumber`
+        # @return [String]
+        attr_accessor :hashed_phone_number
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @address_info = args[:address_info] if args.key?(:address_info)
+          @hashed_email = args[:hashed_email] if args.key?(:hashed_email)
+          @hashed_phone_number = args[:hashed_phone_number] if args.key?(:hashed_phone_number)
+        end
+      end
+      
       # A UserProfile resource lets you list all DFA user profiles that are associated
       # with a Google user account. The profile_id needs to be specified in other API
       # requests.

data/lib/google/apis/dfareporting_v4/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DfareportingV4
       # Version of the google-apis-dfareporting_v4 gem
-      GEM_VERSION = "0.8.0"
+      GEM_VERSION = "0.10.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230321"
+      REVISION = "20230726"
     end
   end
 end

data/lib/google/apis/dfareporting_v4/representations.rb

@@ -922,6 +922,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class OfflineUserAddressInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class OffsetPosition
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -976,18 +982,6 @@ module Google
         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
       
@@ -1444,6 +1438,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class UserIdentifier
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class UserProfile
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2242,6 +2242,8 @@ module Google
           property :quantity, :numeric_string => true, as: 'quantity'
           property :timestamp_micros, :numeric_string => true, as: 'timestampMicros'
           property :treatment_for_underage, as: 'treatmentForUnderage'
+          collection :user_identifiers, as: 'userIdentifiers', class: Google::Apis::DfareportingV4::UserIdentifier, decorator: Google::Apis::DfareportingV4::UserIdentifier::Representation
+      
           property :value, as: 'value'
         end
       end
@@ -3533,6 +3535,19 @@ module Google
         end
       end
       
+      class OfflineUserAddressInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :city, as: 'city'
+          property :country_code, as: 'countryCode'
+          property :hashed_first_name, as: 'hashedFirstName'
+          property :hashed_last_name, as: 'hashedLastName'
+          property :hashed_street_address, as: 'hashedStreetAddress'
+          property :postal_code, as: 'postalCode'
+          property :state, as: 'state'
+        end
+      end
+      
       class OffsetPosition
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3640,42 +3655,6 @@ module Google
         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::DfareportingV4::LastModifiedInfo, decorator: Google::Apis::DfareportingV4::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::DfareportingV4::OrderDocument, decorator: Google::Apis::DfareportingV4::OrderDocument::Representation
-      
-        end
-      end
-      
       class OrdersListResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -4748,6 +4727,16 @@ module Google
         end
       end
       
+      class UserIdentifier
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :address_info, as: 'addressInfo', class: Google::Apis::DfareportingV4::OfflineUserAddressInfo, decorator: Google::Apis::DfareportingV4::OfflineUserAddressInfo::Representation
+      
+          property :hashed_email, as: 'hashedEmail'
+          property :hashed_phone_number, as: 'hashedPhoneNumber'
+        end
+      end
+      
       class UserProfile
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation