pinterest_sdk 1.1.0 → 2.0.0

data/lib/pinterest_sdk/api/campaigns_api.rb

@@ -0,0 +1,878 @@
+=begin
+#Pinterest REST API
+
+#Pinterest's REST API
+
+The version of the OpenAPI document: 5.23.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'cgi'
+
+module PinterestSdkClient
+  class CampaignsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get pins analytics
+    # Get analytics for the pins given a campaign and pins in the specified <code>ad_account_id</code>, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days. Data will not be provided for conversion metrics but will be available for non-conversion metrics.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_id [String] Campaign Id to use to filter the results.
+    # @param pin_ids [Array<String>] List of Pin IDs.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @return [Array<AdPinAnalytics>]
+    def ad_pins_analytics(ad_account_id, campaign_id, pin_ids, start_date, end_date, columns, granularity, opts = {})
+      data, _status_code, _headers = ad_pins_analytics_with_http_info(ad_account_id, campaign_id, pin_ids, start_date, end_date, columns, granularity, opts)
+      data
+    end
+
+    # Get pins analytics
+    # Get analytics for the pins given a campaign and pins in the specified &lt;code&gt;ad_account_id&lt;/code&gt;, filtered by the specified options. - The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via &lt;a href&#x3D;\&quot;https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\&quot;&gt;Business Access&lt;/a&gt;: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days. Data will not be provided for conversion metrics but will be available for non-conversion metrics.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_id [String] Campaign Id to use to filter the results.
+    # @param pin_ids [Array<String>] List of Pin IDs.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @return [Array<(Array<AdPinAnalytics>, Integer, Hash)>] Array<AdPinAnalytics> data, response status code and response headers
+    def ad_pins_analytics_with_http_info(ad_account_id, campaign_id, pin_ids, start_date, end_date, columns, granularity, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.ad_pins_analytics ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.ad_pins_analytics"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.ad_pins_analytics, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.ad_pins_analytics, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling CampaignsApi.ad_pins_analytics"
+      end
+      if @api_client.config.client_side_validation && campaign_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "campaign_id" when calling CampaignsApi.ad_pins_analytics, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && campaign_id !~ pattern
+        fail ArgumentError, "invalid value for 'campaign_id' when calling CampaignsApi.ad_pins_analytics, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'pin_ids' is set
+      if @api_client.config.client_side_validation && pin_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'pin_ids' when calling CampaignsApi.ad_pins_analytics"
+      end
+      if @api_client.config.client_side_validation && pin_ids.length > 100
+        fail ArgumentError, 'invalid value for "pin_ids" when calling CampaignsApi.ad_pins_analytics, number of items must be less than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && pin_ids.length < 1
+        fail ArgumentError, 'invalid value for "pin_ids" when calling CampaignsApi.ad_pins_analytics, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling CampaignsApi.ad_pins_analytics"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling CampaignsApi.ad_pins_analytics"
+      end
+      # verify the required parameter 'columns' is set
+      if @api_client.config.client_side_validation && columns.nil?
+        fail ArgumentError, "Missing the required parameter 'columns' when calling CampaignsApi.ad_pins_analytics"
+      end
+      # verify the required parameter 'granularity' is set
+      if @api_client.config.client_side_validation && granularity.nil?
+        fail ArgumentError, "Missing the required parameter 'granularity' when calling CampaignsApi.ad_pins_analytics"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
+        fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
+        fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
+        fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
+      if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
+        fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/pins/analytics'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'campaign_id'] = campaign_id
+      query_params[:'pin_ids'] = @api_client.build_collection_param(pin_ids, :multi)
+      query_params[:'start_date'] = start_date
+      query_params[:'end_date'] = end_date
+      query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
+      query_params[:'granularity'] = granularity
+      query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
+      query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
+      query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
+      query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AdPinAnalytics>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.ad_pins_analytics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#ad_pins_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get targeting analytics for campaigns
+    # Get targeting analytics for one or more campaigns. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/> - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param targeting_types [Array<AdsAnalyticsCampaignTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type &lt;br&gt; is independent from each other. [\&quot;AGE_BUCKET_AND_GENDER\&quot;] is in BETA and not yet available to all users.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [MetricsResponse]
+    def campaign_targeting_analytics_get(ad_account_id, campaign_ids, start_date, end_date, targeting_types, columns, granularity, opts = {})
+      data, _status_code, _headers = campaign_targeting_analytics_get_with_http_info(ad_account_id, campaign_ids, start_date, end_date, targeting_types, columns, granularity, opts)
+      data
+    end
+
+    # Get targeting analytics for campaigns
+    # Get targeting analytics for one or more campaigns. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \&quot;age_bucket\&quot;) for applicable values (e.g. \&quot;45-49\&quot;). &lt;p/&gt; - The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via &lt;a href&#x3D;\&quot;https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\&quot;&gt;Business Access&lt;/a&gt;: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param targeting_types [Array<AdsAnalyticsCampaignTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type &lt;br&gt; is independent from each other. [\&quot;AGE_BUCKET_AND_GENDER\&quot;] is in BETA and not yet available to all users.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [Array<(MetricsResponse, Integer, Hash)>] MetricsResponse data, response status code and response headers
+    def campaign_targeting_analytics_get_with_http_info(ad_account_id, campaign_ids, start_date, end_date, targeting_types, columns, granularity, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaign_targeting_analytics_get ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaign_targeting_analytics_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaign_targeting_analytics_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_ids' is set
+      if @api_client.config.client_side_validation && campaign_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_ids' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && campaign_ids.length > 250
+        fail ArgumentError, 'invalid value for "campaign_ids" when calling CampaignsApi.campaign_targeting_analytics_get, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && campaign_ids.length < 1
+        fail ArgumentError, 'invalid value for "campaign_ids" when calling CampaignsApi.campaign_targeting_analytics_get, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      # verify the required parameter 'targeting_types' is set
+      if @api_client.config.client_side_validation && targeting_types.nil?
+        fail ArgumentError, "Missing the required parameter 'targeting_types' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && targeting_types.length > 14
+        fail ArgumentError, 'invalid value for "targeting_types" when calling CampaignsApi.campaign_targeting_analytics_get, number of items must be less than or equal to 14.'
+      end
+
+      if @api_client.config.client_side_validation && targeting_types.length < 1
+        fail ArgumentError, 'invalid value for "targeting_types" when calling CampaignsApi.campaign_targeting_analytics_get, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'columns' is set
+      if @api_client.config.client_side_validation && columns.nil?
+        fail ArgumentError, "Missing the required parameter 'columns' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      # verify the required parameter 'granularity' is set
+      if @api_client.config.client_side_validation && granularity.nil?
+        fail ArgumentError, "Missing the required parameter 'granularity' when calling CampaignsApi.campaign_targeting_analytics_get"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
+        fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
+        fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
+        fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
+      if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
+        fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'attribution_types'].nil? && opts[:'attribution_types'].length > 2
+        fail ArgumentError, 'invalid value for "opts[:"attribution_types"]" when calling CampaignsApi.campaign_targeting_analytics_get, number of items must be less than or equal to 2.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns/targeting_analytics'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'campaign_ids'] = @api_client.build_collection_param(campaign_ids, :multi)
+      query_params[:'start_date'] = start_date
+      query_params[:'end_date'] = end_date
+      query_params[:'targeting_types'] = @api_client.build_collection_param(targeting_types, :csv)
+      query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
+      query_params[:'granularity'] = granularity
+      query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
+      query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
+      query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
+      query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
+      query_params[:'attribution_types'] = @api_client.build_collection_param(opts[:'attribution_types'], :csv) if !opts[:'attribution_types'].nil?
+      query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaign_targeting_analytics_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaign_targeting_analytics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get campaign analytics
+    # Get analytics for the specified campaigns in the specified <code>ad_account_id</code>, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Boolean] :aggregate_report_rows Determines if report rows should be aggregated across all requested entities. This feature is currently in BETA and is not available to all users. (default to false)
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [Array<CampaignsAnalyticsResponseInner>]
+    def campaigns_analytics(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts = {})
+      data, _status_code, _headers = campaigns_analytics_with_http_info(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts)
+      data
+    end
+
+    # Get campaign analytics
+    # Get analytics for the specified campaigns in the specified &lt;code&gt;ad_account_id&lt;/code&gt;, filtered by the specified options. - The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via &lt;a href&#x3D;\&quot;https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\&quot;&gt;Business Access&lt;/a&gt;: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
+    # @param columns [Array<String>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.&lt;br/&gt;For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).&lt;br/&gt;If a column has no value, it may not be returned
+    # @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range.&lt;br&gt; DAY - metrics are broken down daily.&lt;br&gt; HOUR - metrics are broken down hourly.&lt;br&gt;WEEKLY - metrics are broken down weekly.&lt;br&gt;MONTHLY - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Integer] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.&lt;br&gt; &lt;strong&gt;Note:&lt;/strong&gt; This parameter no longer returns new data. However, you can still access historic data through &lt;strong&gt;Sept 30, 2027&lt;/strong&gt;. (default to 30)
+    # @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Boolean] :aggregate_report_rows Determines if report rows should be aggregated across all requested entities. This feature is currently in BETA and is not available to all users. (default to false)
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [Array<(Array<CampaignsAnalyticsResponseInner>, Integer, Hash)>] Array<CampaignsAnalyticsResponseInner> data, response status code and response headers
+    def campaigns_analytics_with_http_info(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_analytics ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaigns_analytics"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaigns_analytics, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaigns_analytics, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling CampaignsApi.campaigns_analytics"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling CampaignsApi.campaigns_analytics"
+      end
+      # verify the required parameter 'campaign_ids' is set
+      if @api_client.config.client_side_validation && campaign_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_ids' when calling CampaignsApi.campaigns_analytics"
+      end
+      if @api_client.config.client_side_validation && campaign_ids.length > 250
+        fail ArgumentError, 'invalid value for "campaign_ids" when calling CampaignsApi.campaigns_analytics, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && campaign_ids.length < 1
+        fail ArgumentError, 'invalid value for "campaign_ids" when calling CampaignsApi.campaigns_analytics, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'columns' is set
+      if @api_client.config.client_side_validation && columns.nil?
+        fail ArgumentError, "Missing the required parameter 'columns' when calling CampaignsApi.campaigns_analytics"
+      end
+      # verify the required parameter 'granularity' is set
+      if @api_client.config.client_side_validation && granularity.nil?
+        fail ArgumentError, "Missing the required parameter 'granularity' when calling CampaignsApi.campaigns_analytics"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
+        fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
+        fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
+        fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
+      if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
+        fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns/analytics'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_date'] = start_date
+      query_params[:'end_date'] = end_date
+      query_params[:'campaign_ids'] = @api_client.build_collection_param(campaign_ids, :multi)
+      query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
+      query_params[:'granularity'] = granularity
+      query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
+      query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
+      query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
+      query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
+      query_params[:'aggregate_report_rows'] = opts[:'aggregate_report_rows'] if !opts[:'aggregate_report_rows'].nil?
+      query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CampaignsAnalyticsResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_analytics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create campaigns
+    # Create multiple new campaigns. Every campaign has its own campaign_id and houses one or more ad groups, which contain one or more ads. For more, see <a href=\"https://help.pinterest.com/en/business/article/set-up-your-campaign/\">Set up your campaign</a>. <p/> <strong>Note:</strong> - The values for 'lifetime_spend_cap' and 'daily_spend_cap' are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD) <p/> <p>Microcurrency is used to track very small transactions, based on the currency set in the advertiser’s profile.</p> <p>A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser’s profile.</p> <p><strong>Equivalency equations</strong>, using dollars as an example currency:</p> <ul>   <li>$1 = 1,000,000 microdollars</li>   <li>1 microdollar = $0.000001 </li> </ul> <p><strong>To convert between currency and microcurrency</strong>, using dollars as an example currency:</p> <ul>   <li>To convert dollars to microdollars, mutiply dollars by 1,000,000</li>   <li>To convert microdollars to dollars, divide microdollars by 1,000,000</li> </ul>
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_create_request [Array<CampaignCreateRequest>] Array of campaigns.
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignCreateResponse]
+    def campaigns_create(ad_account_id, campaign_create_request, opts = {})
+      data, _status_code, _headers = campaigns_create_with_http_info(ad_account_id, campaign_create_request, opts)
+      data
+    end
+
+    # Create campaigns
+    # Create multiple new campaigns. Every campaign has its own campaign_id and houses one or more ad groups, which contain one or more ads. For more, see &lt;a href&#x3D;\&quot;https://help.pinterest.com/en/business/article/set-up-your-campaign/\&quot;&gt;Set up your campaign&lt;/a&gt;. &lt;p/&gt; &lt;strong&gt;Note:&lt;/strong&gt; - The values for &#39;lifetime_spend_cap&#39; and &#39;daily_spend_cap&#39; are microcurrency amounts based on the currency field set in the advertiser&#39;s profile. (e.g. USD) &lt;p/&gt; &lt;p&gt;Microcurrency is used to track very small transactions, based on the currency set in the advertiser’s profile.&lt;/p&gt; &lt;p&gt;A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser’s profile.&lt;/p&gt; &lt;p&gt;&lt;strong&gt;Equivalency equations&lt;/strong&gt;, using dollars as an example currency:&lt;/p&gt; &lt;ul&gt;   &lt;li&gt;$1 &#x3D; 1,000,000 microdollars&lt;/li&gt;   &lt;li&gt;1 microdollar &#x3D; $0.000001 &lt;/li&gt; &lt;/ul&gt; &lt;p&gt;&lt;strong&gt;To convert between currency and microcurrency&lt;/strong&gt;, using dollars as an example currency:&lt;/p&gt; &lt;ul&gt;   &lt;li&gt;To convert dollars to microdollars, mutiply dollars by 1,000,000&lt;/li&gt;   &lt;li&gt;To convert microdollars to dollars, divide microdollars by 1,000,000&lt;/li&gt; &lt;/ul&gt;
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_create_request [Array<CampaignCreateRequest>] Array of campaigns.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignCreateResponse, Integer, Hash)>] CampaignCreateResponse data, response status code and response headers
+    def campaigns_create_with_http_info(ad_account_id, campaign_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_create ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaigns_create"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaigns_create, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaigns_create, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_create_request' is set
+      if @api_client.config.client_side_validation && campaign_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_create_request' when calling CampaignsApi.campaigns_create"
+      end
+      if @api_client.config.client_side_validation && campaign_create_request.length > 30
+        fail ArgumentError, 'invalid value for "campaign_create_request" when calling CampaignsApi.campaigns_create, number of items must be less than or equal to 30.'
+      end
+
+      if @api_client.config.client_side_validation && campaign_create_request.length < 1
+        fail ArgumentError, 'invalid value for "campaign_create_request" when calling CampaignsApi.campaigns_create, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CampaignCreateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get campaign
+    # Get a specific campaign given the campaign ID.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_id [String] Campaign ID, must be associated with the ad account ID provided in the path.
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignResponse]
+    def campaigns_get(ad_account_id, campaign_id, opts = {})
+      data, _status_code, _headers = campaigns_get_with_http_info(ad_account_id, campaign_id, opts)
+      data
+    end
+
+    # Get campaign
+    # Get a specific campaign given the campaign ID.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_id [String] Campaign ID, must be associated with the ad account ID provided in the path.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignResponse, Integer, Hash)>] CampaignResponse data, response status code and response headers
+    def campaigns_get_with_http_info(ad_account_id, campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_get ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaigns_get"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaigns_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaigns_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling CampaignsApi.campaigns_get"
+      end
+      if @api_client.config.client_side_validation && campaign_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "campaign_id" when calling CampaignsApi.campaigns_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && campaign_id !~ pattern
+        fail ArgumentError, "invalid value for 'campaign_id' when calling CampaignsApi.campaigns_get, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns/{campaign_id}'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s)).sub('{' + 'campaign_id' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CampaignResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List campaigns
+    # Get a list of the campaigns in the specified <code>ad_account_id</code>, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [Array<String>] :entity_statuses Entity status
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on &lt;a href&#x3D;&#39;/docs/reference/pagination/&#39;&gt;Pagination&lt;/a&gt; for more information. (default to 25)
+    # @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @return [CampaignsList200Response]
+    def campaigns_list(ad_account_id, opts = {})
+      data, _status_code, _headers = campaigns_list_with_http_info(ad_account_id, opts)
+      data
+    end
+
+    # List campaigns
+    # Get a list of the campaigns in the specified &lt;code&gt;ad_account_id&lt;/code&gt;, filtered by the specified options. - The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via &lt;a href&#x3D;\&quot;https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\&quot;&gt;Business Access&lt;/a&gt;: Admin, Analyst, Campaign Manager.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [Array<String>] :entity_statuses Entity status
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on &lt;a href&#x3D;&#39;/docs/reference/pagination/&#39;&gt;Pagination&lt;/a&gt; for more information. (default to 25)
+    # @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @return [Array<(CampaignsList200Response, Integer, Hash)>] CampaignsList200Response data, response status code and response headers
+    def campaigns_list_with_http_info(ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_list ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaigns_list"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaigns_list, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaigns_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling CampaignsApi.campaigns_list, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling CampaignsApi.campaigns_list, number of items must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "DELETED_DRAFT"]
+      if @api_client.config.client_side_validation && opts[:'entity_statuses'] && !opts[:'entity_statuses'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"entity_statuses\", must include one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CampaignsApi.campaigns_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CampaignsApi.campaigns_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["ASCENDING", "DESCENDING"]
+      if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
+        fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
+      query_params[:'entity_statuses'] = @api_client.build_collection_param(opts[:'entity_statuses'], :multi) if !opts[:'entity_statuses'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CampaignsList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update campaigns
+    # <p>Update multiple ad campaigns based on campaign_ids. </p> <p><strong>Note:</strong></p> - <p>The values for `lifetime_spend_cap` and `daily_spend_cap` are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD) <p/> <p>Microcurrency is used to track very small transactions, based on the currency set in the advertiser's profile.</p> <p>A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser's profile.</p> <p><strong>Equivalency equations</strong>, using dollars as an example currency:</p> <ul>   <li>$1 = 1,000,000 microdollars</li>   <li>1 microdollar = $0.000001 </li> </ul> <p><strong>To convert between currency and microcurrency</strong>, using dollars as an example currency:</p> <ul>   <li>To convert dollars to microdollars, mutiply dollars by 1,000,000</li>   <li>To convert microdollars to dollars, divide microdollars by 1,000,000</li> </ul>
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_update_request [Array<CampaignUpdateRequest>] Array of campaigns.
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignUpdateResponse]
+    def campaigns_update(ad_account_id, campaign_update_request, opts = {})
+      data, _status_code, _headers = campaigns_update_with_http_info(ad_account_id, campaign_update_request, opts)
+      data
+    end
+
+    # Update campaigns
+    # &lt;p&gt;Update multiple ad campaigns based on campaign_ids. &lt;/p&gt; &lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt; - &lt;p&gt;The values for &#x60;lifetime_spend_cap&#x60; and &#x60;daily_spend_cap&#x60; are microcurrency amounts based on the currency field set in the advertiser&#39;s profile. (e.g. USD) &lt;p/&gt; &lt;p&gt;Microcurrency is used to track very small transactions, based on the currency set in the advertiser&#39;s profile.&lt;/p&gt; &lt;p&gt;A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser&#39;s profile.&lt;/p&gt; &lt;p&gt;&lt;strong&gt;Equivalency equations&lt;/strong&gt;, using dollars as an example currency:&lt;/p&gt; &lt;ul&gt;   &lt;li&gt;$1 &#x3D; 1,000,000 microdollars&lt;/li&gt;   &lt;li&gt;1 microdollar &#x3D; $0.000001 &lt;/li&gt; &lt;/ul&gt; &lt;p&gt;&lt;strong&gt;To convert between currency and microcurrency&lt;/strong&gt;, using dollars as an example currency:&lt;/p&gt; &lt;ul&gt;   &lt;li&gt;To convert dollars to microdollars, mutiply dollars by 1,000,000&lt;/li&gt;   &lt;li&gt;To convert microdollars to dollars, divide microdollars by 1,000,000&lt;/li&gt; &lt;/ul&gt;
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_update_request [Array<CampaignUpdateRequest>] Array of campaigns.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignUpdateResponse, Integer, Hash)>] CampaignUpdateResponse data, response status code and response headers
+    def campaigns_update_with_http_info(ad_account_id, campaign_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignsApi.campaigns_update ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling CampaignsApi.campaigns_update"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling CampaignsApi.campaigns_update, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling CampaignsApi.campaigns_update, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_update_request' is set
+      if @api_client.config.client_side_validation && campaign_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_update_request' when calling CampaignsApi.campaigns_update"
+      end
+      if @api_client.config.client_side_validation && campaign_update_request.length > 30
+        fail ArgumentError, 'invalid value for "campaign_update_request" when calling CampaignsApi.campaigns_update, number of items must be less than or equal to 30.'
+      end
+
+      if @api_client.config.client_side_validation && campaign_update_request.length < 1
+        fail ArgumentError, 'invalid value for "campaign_update_request" when calling CampaignsApi.campaigns_update, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaigns'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CampaignUpdateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CampaignsApi.campaigns_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CampaignsApi#campaigns_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end