diff --git a/api_names_out.yaml b/api_names_out.yaml index a92611113..b04912d85 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -125560,15 +125560,31 @@ "/qpxExpress:v1/qpxExpress.trips.search": search_trips "/qpxExpress:v1/quotaUser": quota_user "/qpxExpress:v1/userIp": user_ip +"/realtimebidding:v1/ActivatePretargetingConfigRequest": activate_pretargeting_config_request "/realtimebidding:v1/AdTechnologyProviders": ad_technology_providers "/realtimebidding:v1/AdTechnologyProviders/detectedProviderIds": detected_provider_ids "/realtimebidding:v1/AdTechnologyProviders/detectedProviderIds/detected_provider_id": detected_provider_id "/realtimebidding:v1/AdTechnologyProviders/hasUnidentifiedProvider": has_unidentified_provider +"/realtimebidding:v1/AddTargetedAppsRequest": add_targeted_apps_request +"/realtimebidding:v1/AddTargetedAppsRequest/appIds": app_ids +"/realtimebidding:v1/AddTargetedAppsRequest/appIds/app_id": app_id +"/realtimebidding:v1/AddTargetedAppsRequest/targetingMode": targeting_mode +"/realtimebidding:v1/AddTargetedPublishersRequest": add_targeted_publishers_request +"/realtimebidding:v1/AddTargetedPublishersRequest/publisherIds": publisher_ids +"/realtimebidding:v1/AddTargetedPublishersRequest/publisherIds/publisher_id": publisher_id +"/realtimebidding:v1/AddTargetedPublishersRequest/targetingMode": targeting_mode +"/realtimebidding:v1/AddTargetedSitesRequest": add_targeted_sites_request +"/realtimebidding:v1/AddTargetedSitesRequest/sites": sites +"/realtimebidding:v1/AddTargetedSitesRequest/sites/site": site +"/realtimebidding:v1/AddTargetedSitesRequest/targetingMode": targeting_mode "/realtimebidding:v1/AdvertiserAndBrand": advertiser_and_brand "/realtimebidding:v1/AdvertiserAndBrand/advertiserId": advertiser_id "/realtimebidding:v1/AdvertiserAndBrand/advertiserName": advertiser_name "/realtimebidding:v1/AdvertiserAndBrand/brandId": brand_id "/realtimebidding:v1/AdvertiserAndBrand/brandName": brand_name +"/realtimebidding:v1/AppTargeting": app_targeting +"/realtimebidding:v1/AppTargeting/mobileAppCategoryTargeting": mobile_app_category_targeting +"/realtimebidding:v1/AppTargeting/mobileAppTargeting": mobile_app_targeting "/realtimebidding:v1/CloseUserListRequest": close_user_list_request "/realtimebidding:v1/Creative": creative "/realtimebidding:v1/Creative/accountId": account_id @@ -125598,6 +125614,9 @@ "/realtimebidding:v1/Creative/restrictedCategories/restricted_category": restricted_category "/realtimebidding:v1/Creative/version": version "/realtimebidding:v1/Creative/video": video +"/realtimebidding:v1/CreativeDimensions": creative_dimensions +"/realtimebidding:v1/CreativeDimensions/height": height +"/realtimebidding:v1/CreativeDimensions/width": width "/realtimebidding:v1/CreativeServingDecision": creative_serving_decision "/realtimebidding:v1/CreativeServingDecision/adTechnologyProviders": ad_technology_providers "/realtimebidding:v1/CreativeServingDecision/chinaPolicyCompliance": china_policy_compliance @@ -125656,6 +125675,7 @@ "/realtimebidding:v1/DownloadSizeEvidence/topUrlDownloadSizeBreakdowns": top_url_download_size_breakdowns "/realtimebidding:v1/DownloadSizeEvidence/topUrlDownloadSizeBreakdowns/top_url_download_size_breakdown": top_url_download_size_breakdown "/realtimebidding:v1/DownloadSizeEvidence/totalDownloadSizeKb": total_download_size_kb +"/realtimebidding:v1/Empty": empty "/realtimebidding:v1/GetRemarketingTagResponse": get_remarketing_tag_response "/realtimebidding:v1/GetRemarketingTagResponse/snippet": snippet "/realtimebidding:v1/HtmlContent": html_content @@ -125677,6 +125697,10 @@ "/realtimebidding:v1/ListCreativesResponse/creatives": creatives "/realtimebidding:v1/ListCreativesResponse/creatives/creative": creative "/realtimebidding:v1/ListCreativesResponse/nextPageToken": next_page_token +"/realtimebidding:v1/ListPretargetingConfigsResponse": list_pretargeting_configs_response +"/realtimebidding:v1/ListPretargetingConfigsResponse/nextPageToken": next_page_token +"/realtimebidding:v1/ListPretargetingConfigsResponse/pretargetingConfigs": pretargeting_configs +"/realtimebidding:v1/ListPretargetingConfigsResponse/pretargetingConfigs/pretargeting_config": pretargeting_config "/realtimebidding:v1/ListUserListsResponse": list_user_lists_response "/realtimebidding:v1/ListUserListsResponse/nextPageToken": next_page_token "/realtimebidding:v1/ListUserListsResponse/userLists": user_lists @@ -125697,6 +125721,11 @@ "/realtimebidding:v1/NativeContent/priceDisplayText": price_display_text "/realtimebidding:v1/NativeContent/starRating": star_rating "/realtimebidding:v1/NativeContent/videoUrl": video_url +"/realtimebidding:v1/NumericTargetingDimension": numeric_targeting_dimension +"/realtimebidding:v1/NumericTargetingDimension/excludedIds": excluded_ids +"/realtimebidding:v1/NumericTargetingDimension/excludedIds/excluded_id": excluded_id +"/realtimebidding:v1/NumericTargetingDimension/includedIds": included_ids +"/realtimebidding:v1/NumericTargetingDimension/includedIds/included_id": included_id "/realtimebidding:v1/OpenUserListRequest": open_user_list_request "/realtimebidding:v1/PolicyCompliance": policy_compliance "/realtimebidding:v1/PolicyCompliance/status": status @@ -125715,10 +125744,58 @@ "/realtimebidding:v1/PolicyTopicEvidence/downloadSize": download_size "/realtimebidding:v1/PolicyTopicEvidence/httpCall": http_call "/realtimebidding:v1/PolicyTopicEvidence/httpCookie": http_cookie +"/realtimebidding:v1/PretargetingConfig": pretargeting_config +"/realtimebidding:v1/PretargetingConfig/allowedUserTargetingModes": allowed_user_targeting_modes +"/realtimebidding:v1/PretargetingConfig/allowedUserTargetingModes/allowed_user_targeting_mode": allowed_user_targeting_mode +"/realtimebidding:v1/PretargetingConfig/appTargeting": app_targeting +"/realtimebidding:v1/PretargetingConfig/billingId": billing_id +"/realtimebidding:v1/PretargetingConfig/displayName": display_name +"/realtimebidding:v1/PretargetingConfig/excludedContentLabelIds": excluded_content_label_ids +"/realtimebidding:v1/PretargetingConfig/excludedContentLabelIds/excluded_content_label_id": excluded_content_label_id +"/realtimebidding:v1/PretargetingConfig/geoTargeting": geo_targeting +"/realtimebidding:v1/PretargetingConfig/includedCreativeDimensions": included_creative_dimensions +"/realtimebidding:v1/PretargetingConfig/includedCreativeDimensions/included_creative_dimension": included_creative_dimension +"/realtimebidding:v1/PretargetingConfig/includedEnvironments": included_environments +"/realtimebidding:v1/PretargetingConfig/includedEnvironments/included_environment": included_environment +"/realtimebidding:v1/PretargetingConfig/includedFormats": included_formats +"/realtimebidding:v1/PretargetingConfig/includedFormats/included_format": included_format +"/realtimebidding:v1/PretargetingConfig/includedLanguages": included_languages +"/realtimebidding:v1/PretargetingConfig/includedLanguages/included_language": included_language +"/realtimebidding:v1/PretargetingConfig/includedMobileOperatingSystemIds": included_mobile_operating_system_ids +"/realtimebidding:v1/PretargetingConfig/includedMobileOperatingSystemIds/included_mobile_operating_system_id": included_mobile_operating_system_id +"/realtimebidding:v1/PretargetingConfig/includedPlatforms": included_platforms +"/realtimebidding:v1/PretargetingConfig/includedPlatforms/included_platform": included_platform +"/realtimebidding:v1/PretargetingConfig/includedUserIdTypes": included_user_id_types +"/realtimebidding:v1/PretargetingConfig/includedUserIdTypes/included_user_id_type": included_user_id_type +"/realtimebidding:v1/PretargetingConfig/interstitialTargeting": interstitial_targeting +"/realtimebidding:v1/PretargetingConfig/invalidGeoIds": invalid_geo_ids +"/realtimebidding:v1/PretargetingConfig/invalidGeoIds/invalid_geo_id": invalid_geo_id +"/realtimebidding:v1/PretargetingConfig/maximumQps": maximum_qps +"/realtimebidding:v1/PretargetingConfig/minimumViewabilityDecile": minimum_viewability_decile +"/realtimebidding:v1/PretargetingConfig/name": name +"/realtimebidding:v1/PretargetingConfig/publisherTargeting": publisher_targeting +"/realtimebidding:v1/PretargetingConfig/state": state +"/realtimebidding:v1/PretargetingConfig/userListTargeting": user_list_targeting +"/realtimebidding:v1/PretargetingConfig/verticalTargeting": vertical_targeting +"/realtimebidding:v1/PretargetingConfig/webTargeting": web_targeting +"/realtimebidding:v1/RemoveTargetedAppsRequest": remove_targeted_apps_request +"/realtimebidding:v1/RemoveTargetedAppsRequest/appIds": app_ids +"/realtimebidding:v1/RemoveTargetedAppsRequest/appIds/app_id": app_id +"/realtimebidding:v1/RemoveTargetedPublishersRequest": remove_targeted_publishers_request +"/realtimebidding:v1/RemoveTargetedPublishersRequest/publisherIds": publisher_ids +"/realtimebidding:v1/RemoveTargetedPublishersRequest/publisherIds/publisher_id": publisher_id +"/realtimebidding:v1/RemoveTargetedSitesRequest": remove_targeted_sites_request +"/realtimebidding:v1/RemoveTargetedSitesRequest/sites": sites +"/realtimebidding:v1/RemoveTargetedSitesRequest/sites/site": site "/realtimebidding:v1/ServingStatus": serving_status "/realtimebidding:v1/ServingStatus/status": status "/realtimebidding:v1/ServingStatus/topics": topics "/realtimebidding:v1/ServingStatus/topics/topic": topic +"/realtimebidding:v1/StringTargetingDimension": string_targeting_dimension +"/realtimebidding:v1/StringTargetingDimension/targetingMode": targeting_mode +"/realtimebidding:v1/StringTargetingDimension/values": values +"/realtimebidding:v1/StringTargetingDimension/values/value": value +"/realtimebidding:v1/SuspendPretargetingConfigRequest": suspend_pretargeting_config_request "/realtimebidding:v1/UrlDownloadSize": url_download_size "/realtimebidding:v1/UrlDownloadSize/downloadSizeKb": download_size_kb "/realtimebidding:v1/UrlDownloadSize/normalizedUrl": normalized_url @@ -125761,6 +125838,35 @@ "/realtimebidding:v1/realtimebidding.bidders.creatives.list/view": view "/realtimebidding:v1/realtimebidding.bidders.creatives.watch": watch_creatives "/realtimebidding:v1/realtimebidding.bidders.creatives.watch/parent": parent +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.activate": activate_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.activate/name": name +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedApps": add_pretargeting_config_targeted_apps +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedApps/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedPublishers": add_pretargeting_config_targeted_publishers +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedPublishers/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedSites": add_pretargeting_config_targeted_sites +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.addTargetedSites/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.create": create_bidder_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.create/parent": parent +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.delete": delete_bidder_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.delete/name": name +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.get": get_bidder_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.get/name": name +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.list": list_bidder_pretargeting_configs +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.list/pageSize": page_size +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.list/pageToken": page_token +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.list/parent": parent +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.patch": patch_bidder_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.patch/name": name +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.patch/updateMask": update_mask +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedApps": remove_pretargeting_config_targeted_apps +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedApps/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedPublishers": remove_pretargeting_config_targeted_publishers +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedPublishers/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedSites": remove_pretargeting_config_targeted_sites +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.removeTargetedSites/pretargetingConfig": pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.suspend": suspend_pretargeting_config +"/realtimebidding:v1/realtimebidding.bidders.pretargetingConfigs.suspend/name": name "/realtimebidding:v1/realtimebidding.buyers.creatives.create": create_buyer_creative "/realtimebidding:v1/realtimebidding.buyers.creatives.create/parent": parent "/realtimebidding:v1/realtimebidding.buyers.creatives.get": get_buyer_creative diff --git a/generated/google/apis/realtimebidding_v1.rb b/generated/google/apis/realtimebidding_v1.rb index ea6a42e1a..8e0e6415f 100644 --- a/generated/google/apis/realtimebidding_v1.rb +++ b/generated/google/apis/realtimebidding_v1.rb @@ -28,7 +28,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/ module RealtimebiddingV1 VERSION = 'V1' - REVISION = '20201013' + REVISION = '20201109' # See, create, edit, and delete your Authorized Buyers and Open Bidding account entities AUTH_REALTIME_BIDDING = 'https://www.googleapis.com/auth/realtime-bidding' diff --git a/generated/google/apis/realtimebidding_v1/classes.rb b/generated/google/apis/realtimebidding_v1/classes.rb index 97dc3b74b..dbcd8822e 100644 --- a/generated/google/apis/realtimebidding_v1/classes.rb +++ b/generated/google/apis/realtimebidding_v1/classes.rb @@ -22,6 +22,118 @@ module Google module Apis module RealtimebiddingV1 + # A request to activate a pretargeting configuration. Sets the configuration's + # state to ACTIVE. + class ActivatePretargetingConfigRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A request to start targeting the provided app IDs in a specific pretargeting + # configuration. The pretargeting configuration itself specifies how these apps + # are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting. + class AddTargetedAppsRequest + include Google::Apis::Core::Hashable + + # A list of app IDs to target in the pretargeting configuration. These values + # will be added to the list of targeted app IDs in PretargetingConfig. + # appTargeting.mobileAppTargeting.values. + # Corresponds to the JSON property `appIds` + # @return [Array] + attr_accessor :app_ids + + # Required. The targeting mode that should be applied to the list of app IDs. If + # there are existing targeted app IDs, must be equal to the existing + # PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400 bad + # request error will be returned. + # Corresponds to the JSON property `targetingMode` + # @return [String] + attr_accessor :targeting_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_ids = args[:app_ids] if args.key?(:app_ids) + @targeting_mode = args[:targeting_mode] if args.key?(:targeting_mode) + end + end + + # A request to start targeting the provided publishers in a specific + # pretargeting configuration. The pretargeting configuration itself specifies + # how these publishers are targeted in PretargetingConfig.publisherTargeting. + class AddTargetedPublishersRequest + include Google::Apis::Core::Hashable + + # A list of publisher IDs to target in the pretargeting configuration. These + # values will be added to the list of targeted publisher IDs in + # PretargetingConfig.publisherTargeting.values. Publishers are identified by + # their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads- + # txt/ and https://iabtechlab.com/app-ads-txt/ for more details. + # Corresponds to the JSON property `publisherIds` + # @return [Array] + attr_accessor :publisher_ids + + # Required. The targeting mode that should be applied to the list of publisher + # IDs. If are existing publisher IDs, must be equal to the existing + # PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error + # will be returned. + # Corresponds to the JSON property `targetingMode` + # @return [String] + attr_accessor :targeting_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @publisher_ids = args[:publisher_ids] if args.key?(:publisher_ids) + @targeting_mode = args[:targeting_mode] if args.key?(:targeting_mode) + end + end + + # A request to start targeting the provided sites in a specific pretargeting + # configuration. The pretargeting configuration itself specifies how these sites + # are targeted in PretargetingConfig.webTargeting. + class AddTargetedSitesRequest + include Google::Apis::Core::Hashable + + # A list of site URLs to target in the pretargeting configuration. These values + # will be added to the list of targeted URLs in PretargetingConfig.webTargeting. + # values. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + # Required. The targeting mode that should be applied to the list of site URLs. + # If there are existing targeted sites, must be equal to the existing + # PretargetingConfig.webTargeting.targetingMode or a 400 bad request error will + # be returned. + # Corresponds to the JSON property `targetingMode` + # @return [String] + attr_accessor :targeting_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sites = args[:sites] if args.key?(:sites) + @targeting_mode = args[:targeting_mode] if args.key?(:targeting_mode) + end + end + # Detected advertiser and brand information. class AdvertiserAndBrand include Google::Apis::Core::Hashable @@ -64,6 +176,35 @@ module Google end end + # A subset of app inventory to target. Bid requests that match criteria in at + # least one of the specified dimensions will be sent. + class AppTargeting + include Google::Apis::Core::Hashable + + # Generic targeting used for targeting dimensions that contain a list of + # included and excluded numeric IDs used in app, user list, geo, and vertical id + # targeting. + # Corresponds to the JSON property `mobileAppCategoryTargeting` + # @return [Google::Apis::RealtimebiddingV1::NumericTargetingDimension] + attr_accessor :mobile_app_category_targeting + + # Generic targeting with string values used in app, website and publisher + # targeting. + # Corresponds to the JSON property `mobileAppTargeting` + # @return [Google::Apis::RealtimebiddingV1::StringTargetingDimension] + attr_accessor :mobile_app_targeting + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mobile_app_category_targeting = args[:mobile_app_category_targeting] if args.key?(:mobile_app_category_targeting) + @mobile_app_targeting = args[:mobile_app_targeting] if args.key?(:mobile_app_targeting) + end + end + # A request to close a specified user list. class CloseUserListRequest include Google::Apis::Core::Hashable @@ -232,6 +373,31 @@ module Google end end + # The dimensions of a creative. This applies to only HTML and Native creatives. + class CreativeDimensions + include Google::Apis::Core::Hashable + + # The height of the creative in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The width of the creative in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height = args[:height] if args.key?(:height) + @width = args[:width] if args.key?(:width) + end + end + # Top level status and detected attributes of a creative. class CreativeServingDecision include Google::Apis::Core::Hashable @@ -582,6 +748,23 @@ module Google end end + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Response for a request to get remarketing tag. class GetRemarketingTagResponse include Google::Apis::Core::Hashable @@ -746,6 +929,33 @@ module Google end end + # A response containing pretargeting configurations. + class ListPretargetingConfigsResponse + include Google::Apis::Core::Hashable + + # A token which can be passed to a subsequent call to the ` + # ListPretargetingConfigs` method to retrieve the next page of results in + # ListPretargetingConfigsRequest.pageToken. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of pretargeting configurations. + # Corresponds to the JSON property `pretargetingConfigs` + # @return [Array] + attr_accessor :pretargeting_configs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @pretargeting_configs = args[:pretargeting_configs] if args.key?(:pretargeting_configs) + end + end + # The list user list response. class ListUserListsResponse include Google::Apis::Core::Hashable @@ -889,6 +1099,33 @@ module Google end end + # Generic targeting used for targeting dimensions that contain a list of + # included and excluded numeric IDs used in app, user list, geo, and vertical id + # targeting. + class NumericTargetingDimension + include Google::Apis::Core::Hashable + + # The IDs excluded in a configuration. + # Corresponds to the JSON property `excludedIds` + # @return [Array] + attr_accessor :excluded_ids + + # The IDs included in a configuration. + # Corresponds to the JSON property `includedIds` + # @return [Array] + attr_accessor :included_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excluded_ids = args[:excluded_ids] if args.key?(:excluded_ids) + @included_ids = args[:included_ids] if args.key?(:included_ids) + end + end + # A request to open a specified user list. class OpenUserListRequest include Google::Apis::Core::Hashable @@ -1024,6 +1261,314 @@ module Google end end + # Pretargeting configuration: a set of targeting dimensions applied at the + # pretargeting stage of the RTB funnel. These control which inventory a bidder + # will receive bid requests for. + class PretargetingConfig + include Google::Apis::Core::Hashable + + # Targeting modes included by this configuration. A bid request must allow all + # the specified targeting modes. An unset value allows all bid requests to be + # sent, regardless of which targeting modes they allow. + # Corresponds to the JSON property `allowedUserTargetingModes` + # @return [Array] + attr_accessor :allowed_user_targeting_modes + + # A subset of app inventory to target. Bid requests that match criteria in at + # least one of the specified dimensions will be sent. + # Corresponds to the JSON property `appTargeting` + # @return [Google::Apis::RealtimebiddingV1::AppTargeting] + attr_accessor :app_targeting + + # Output only. The identifier that corresponds to this pretargeting + # configuration that helps buyers track and attribute their spend across their + # own arbitrary divisions. If a bid request matches more than one configuration, + # the buyer chooses which billing_id to attribute each of their bids. + # Corresponds to the JSON property `billingId` + # @return [Fixnum] + attr_accessor :billing_id + + # The diplay name associated with this configuration. This name must be unique + # among all the pretargeting configurations a bidder has. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The sensitive content category label IDs excluded in this configuration. Bid + # requests for inventory with any of the specified content label IDs will not be + # sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/ + # content-labels.txt for category IDs. + # Corresponds to the JSON property `excludedContentLabelIds` + # @return [Array] + attr_accessor :excluded_content_label_ids + + # Generic targeting used for targeting dimensions that contain a list of + # included and excluded numeric IDs used in app, user list, geo, and vertical id + # targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::RealtimebiddingV1::NumericTargetingDimension] + attr_accessor :geo_targeting + + # Creative dimensions included by this configuration. Only bid requests eligible + # for at least one of the specified creative dimensions will be sent. An unset + # value allows all bid requests to be sent, regardless of creative dimension. + # Corresponds to the JSON property `includedCreativeDimensions` + # @return [Array] + attr_accessor :included_creative_dimensions + + # Environments that are being included. Bid requests will not be sent for a + # given environment if it is not included. Further restrictions can be applied + # to included environments to target only a subset of its inventory. An unset + # value includes all environments. + # Corresponds to the JSON property `includedEnvironments` + # @return [Array] + attr_accessor :included_environments + + # Creative formats included by this configuration. Only bid requests eligible + # for at least one of the specified creative formats will be sent. An unset + # value will allow all bid requests to be sent, regardless of format. + # Corresponds to the JSON property `includedFormats` + # @return [Array] + attr_accessor :included_formats + + # The languages included in this configuration, represented by their language + # code. See https://developers.google.com/adwords/api/docs/appendix/ + # languagecodes. + # Corresponds to the JSON property `includedLanguages` + # @return [Array] + attr_accessor :included_languages + + # The mobile operating systems included in this configuration as defined in + # https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv + # Corresponds to the JSON property `includedMobileOperatingSystemIds` + # @return [Array] + attr_accessor :included_mobile_operating_system_ids + + # The platforms included by this configration. Bid requests for devices with the + # specified platform types will be sent. An unset value allows all bid requests + # to be sent, regardless of platform. + # Corresponds to the JSON property `includedPlatforms` + # @return [Array] + attr_accessor :included_platforms + + # User identifier types included in this configuration. At least one of the user + # identifier types specified in this list must be available for the bid request + # to be sent. + # Corresponds to the JSON property `includedUserIdTypes` + # @return [Array] + attr_accessor :included_user_id_types + + # The interstitial targeting specified for this configuration. The unset value + # will allow bid requests to be sent regardless of whether they are for + # interstitials or not. + # Corresponds to the JSON property `interstitialTargeting` + # @return [String] + attr_accessor :interstitial_targeting + + # Output only. Existing included or excluded geos that are invalid. Previously + # targeted geos may become invalid due to privacy restrictions. + # Corresponds to the JSON property `invalidGeoIds` + # @return [Array] + attr_accessor :invalid_geo_ids + + # The maximum QPS threshold for this configuration. The bidder should receive no + # more than this number of bid requests matching this configuration per second + # across all their bidding endpoints among all trading locations. Further + # information available at https://developers.google.com/authorized-buyers/rtb/ + # peer-guide + # Corresponds to the JSON property `maximumQps` + # @return [Fixnum] + attr_accessor :maximum_qps + + # The targeted minimum viewability decile, ranging in values [0, 10]. A value of + # 5 means that the configuration will only match adslots for which we predict at + # least 50% viewability. Values > 10 will be rounded down to 10. An unset value + # or a value of 0 indicates that bid requests will be sent regardless of + # viewability. + # Corresponds to the JSON property `minimumViewabilityDecile` + # @return [Fixnum] + attr_accessor :minimum_viewability_decile + + # Output only. Name of the pretargeting configuration that must follow the + # pattern `bidders/`bidder_account_id`/pretargetingConfigs/`config_id`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Generic targeting with string values used in app, website and publisher + # targeting. + # Corresponds to the JSON property `publisherTargeting` + # @return [Google::Apis::RealtimebiddingV1::StringTargetingDimension] + attr_accessor :publisher_targeting + + # Output only. The state of this pretargeting configuration. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Generic targeting used for targeting dimensions that contain a list of + # included and excluded numeric IDs used in app, user list, geo, and vertical id + # targeting. + # Corresponds to the JSON property `userListTargeting` + # @return [Google::Apis::RealtimebiddingV1::NumericTargetingDimension] + attr_accessor :user_list_targeting + + # Generic targeting used for targeting dimensions that contain a list of + # included and excluded numeric IDs used in app, user list, geo, and vertical id + # targeting. + # Corresponds to the JSON property `verticalTargeting` + # @return [Google::Apis::RealtimebiddingV1::NumericTargetingDimension] + attr_accessor :vertical_targeting + + # Generic targeting with string values used in app, website and publisher + # targeting. + # Corresponds to the JSON property `webTargeting` + # @return [Google::Apis::RealtimebiddingV1::StringTargetingDimension] + attr_accessor :web_targeting + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_user_targeting_modes = args[:allowed_user_targeting_modes] if args.key?(:allowed_user_targeting_modes) + @app_targeting = args[:app_targeting] if args.key?(:app_targeting) + @billing_id = args[:billing_id] if args.key?(:billing_id) + @display_name = args[:display_name] if args.key?(:display_name) + @excluded_content_label_ids = args[:excluded_content_label_ids] if args.key?(:excluded_content_label_ids) + @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) + @included_creative_dimensions = args[:included_creative_dimensions] if args.key?(:included_creative_dimensions) + @included_environments = args[:included_environments] if args.key?(:included_environments) + @included_formats = args[:included_formats] if args.key?(:included_formats) + @included_languages = args[:included_languages] if args.key?(:included_languages) + @included_mobile_operating_system_ids = args[:included_mobile_operating_system_ids] if args.key?(:included_mobile_operating_system_ids) + @included_platforms = args[:included_platforms] if args.key?(:included_platforms) + @included_user_id_types = args[:included_user_id_types] if args.key?(:included_user_id_types) + @interstitial_targeting = args[:interstitial_targeting] if args.key?(:interstitial_targeting) + @invalid_geo_ids = args[:invalid_geo_ids] if args.key?(:invalid_geo_ids) + @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps) + @minimum_viewability_decile = args[:minimum_viewability_decile] if args.key?(:minimum_viewability_decile) + @name = args[:name] if args.key?(:name) + @publisher_targeting = args[:publisher_targeting] if args.key?(:publisher_targeting) + @state = args[:state] if args.key?(:state) + @user_list_targeting = args[:user_list_targeting] if args.key?(:user_list_targeting) + @vertical_targeting = args[:vertical_targeting] if args.key?(:vertical_targeting) + @web_targeting = args[:web_targeting] if args.key?(:web_targeting) + end + end + + # A request to stop targeting the provided apps in a specific pretargeting + # configuration. The pretargeting configuration itself specifies how these apps + # are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting. + class RemoveTargetedAppsRequest + include Google::Apis::Core::Hashable + + # A list of app IDs to stop targeting in the pretargeting configuration. These + # values will be removed from the list of targeted app IDs in PretargetingConfig. + # appTargeting.mobileAppTargeting.values. + # Corresponds to the JSON property `appIds` + # @return [Array] + attr_accessor :app_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_ids = args[:app_ids] if args.key?(:app_ids) + end + end + + # A request to stop targeting publishers in a specific configuration. The + # pretargeting configuration itself specifies how these publishers are targeted + # in PretargetingConfig.publisherTargeting. + class RemoveTargetedPublishersRequest + include Google::Apis::Core::Hashable + + # A list of publisher IDs to stop targeting in the pretargeting configuration. + # These values will be removed from the list of targeted publisher IDs in + # PretargetingConfig.publisherTargeting.values. Publishers are identified by + # their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads- + # txt/ and https://iabtechlab.com/app-ads-txt/ for more details. + # Corresponds to the JSON property `publisherIds` + # @return [Array] + attr_accessor :publisher_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @publisher_ids = args[:publisher_ids] if args.key?(:publisher_ids) + end + end + + # A request to stop targeting sites in a specific pretargeting configuration. + # The pretargeting configuration itself specifies how these sites are targeted + # in PretargetingConfig.webTargeting. + class RemoveTargetedSitesRequest + include Google::Apis::Core::Hashable + + # A list of site URLs to stop targeting in the pretargeting configuration. These + # values will be removed from the list of targeted URLs in PretargetingConfig. + # webTargeting.values. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sites = args[:sites] if args.key?(:sites) + end + end + + # Generic targeting with string values used in app, website and publisher + # targeting. + class StringTargetingDimension + include Google::Apis::Core::Hashable + + # How the items in this list should be targeted. + # Corresponds to the JSON property `targetingMode` + # @return [String] + attr_accessor :targeting_mode + + # The values specified. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @targeting_mode = args[:targeting_mode] if args.key?(:targeting_mode) + @values = args[:values] if args.key?(:values) + end + end + + # A request to suspend a pretargeting configuration. Sets the configuration's + # state to SUSPENDED. + class SuspendPretargetingConfigRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # The URL-level breakdown for the download size. class UrlDownloadSize include Google::Apis::Core::Hashable diff --git a/generated/google/apis/realtimebidding_v1/representations.rb b/generated/google/apis/realtimebidding_v1/representations.rb index 3bbfb897c..84c8ff095 100644 --- a/generated/google/apis/realtimebidding_v1/representations.rb +++ b/generated/google/apis/realtimebidding_v1/representations.rb @@ -22,12 +22,42 @@ module Google module Apis module RealtimebiddingV1 + class ActivatePretargetingConfigRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddTargetedAppsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddTargetedPublishersRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddTargetedSitesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AdvertiserAndBrand class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class AppTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CloseUserListRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -40,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreativeDimensions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreativeServingDecision class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +124,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GetRemarketingTagResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -124,6 +166,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListPretargetingConfigsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListUserListsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +190,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NumericTargetingDimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OpenUserListRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -166,6 +220,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PretargetingConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemoveTargetedAppsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemoveTargetedPublishersRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemoveTargetedSitesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StringTargetingDimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SuspendPretargetingConfigRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class UrlDownloadSize class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,6 +298,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ActivatePretargetingConfigRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class AddTargetedAppsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :app_ids, as: 'appIds' + property :targeting_mode, as: 'targetingMode' + end + end + + class AddTargetedPublishersRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :publisher_ids, as: 'publisherIds' + property :targeting_mode, as: 'targetingMode' + end + end + + class AddTargetedSitesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :sites, as: 'sites' + property :targeting_mode, as: 'targetingMode' + end + end + class AdvertiserAndBrand # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -218,6 +338,16 @@ module Google end end + class AppTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :mobile_app_category_targeting, as: 'mobileAppCategoryTargeting', class: Google::Apis::RealtimebiddingV1::NumericTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::NumericTargetingDimension::Representation + + property :mobile_app_targeting, as: 'mobileAppTargeting', class: Google::Apis::RealtimebiddingV1::StringTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::StringTargetingDimension::Representation + + end + end + class CloseUserListRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -254,6 +384,14 @@ module Google end end + class CreativeDimensions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height, :numeric_string => true, as: 'height' + property :width, :numeric_string => true, as: 'width' + end + end + class CreativeServingDecision # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -345,6 +483,12 @@ module Google end end + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class GetRemarketingTagResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -394,6 +538,15 @@ module Google end end + class ListPretargetingConfigsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :pretargeting_configs, as: 'pretargetingConfigs', class: Google::Apis::RealtimebiddingV1::PretargetingConfig, decorator: Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + + end + end + class ListUserListsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -432,6 +585,14 @@ module Google end end + class NumericTargetingDimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :excluded_ids, as: 'excludedIds' + collection :included_ids, as: 'includedIds' + end + end + class OpenUserListRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -477,6 +638,77 @@ module Google end end + class PretargetingConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_user_targeting_modes, as: 'allowedUserTargetingModes' + property :app_targeting, as: 'appTargeting', class: Google::Apis::RealtimebiddingV1::AppTargeting, decorator: Google::Apis::RealtimebiddingV1::AppTargeting::Representation + + property :billing_id, :numeric_string => true, as: 'billingId' + property :display_name, as: 'displayName' + collection :excluded_content_label_ids, as: 'excludedContentLabelIds' + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::RealtimebiddingV1::NumericTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::NumericTargetingDimension::Representation + + collection :included_creative_dimensions, as: 'includedCreativeDimensions', class: Google::Apis::RealtimebiddingV1::CreativeDimensions, decorator: Google::Apis::RealtimebiddingV1::CreativeDimensions::Representation + + collection :included_environments, as: 'includedEnvironments' + collection :included_formats, as: 'includedFormats' + collection :included_languages, as: 'includedLanguages' + collection :included_mobile_operating_system_ids, as: 'includedMobileOperatingSystemIds' + collection :included_platforms, as: 'includedPlatforms' + collection :included_user_id_types, as: 'includedUserIdTypes' + property :interstitial_targeting, as: 'interstitialTargeting' + collection :invalid_geo_ids, as: 'invalidGeoIds' + property :maximum_qps, :numeric_string => true, as: 'maximumQps' + property :minimum_viewability_decile, as: 'minimumViewabilityDecile' + property :name, as: 'name' + property :publisher_targeting, as: 'publisherTargeting', class: Google::Apis::RealtimebiddingV1::StringTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::StringTargetingDimension::Representation + + property :state, as: 'state' + property :user_list_targeting, as: 'userListTargeting', class: Google::Apis::RealtimebiddingV1::NumericTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::NumericTargetingDimension::Representation + + property :vertical_targeting, as: 'verticalTargeting', class: Google::Apis::RealtimebiddingV1::NumericTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::NumericTargetingDimension::Representation + + property :web_targeting, as: 'webTargeting', class: Google::Apis::RealtimebiddingV1::StringTargetingDimension, decorator: Google::Apis::RealtimebiddingV1::StringTargetingDimension::Representation + + end + end + + class RemoveTargetedAppsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :app_ids, as: 'appIds' + end + end + + class RemoveTargetedPublishersRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :publisher_ids, as: 'publisherIds' + end + end + + class RemoveTargetedSitesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :sites, as: 'sites' + end + end + + class StringTargetingDimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :targeting_mode, as: 'targetingMode' + collection :values, as: 'values' + end + end + + class SuspendPretargetingConfigRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class UrlDownloadSize # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/realtimebidding_v1/service.rb b/generated/google/apis/realtimebidding_v1/service.rb index c849c10fe..b5c2cc34b 100644 --- a/generated/google/apis/realtimebidding_v1/service.rb +++ b/generated/google/apis/realtimebidding_v1/service.rb @@ -152,6 +152,456 @@ module Google execute_or_queue_command(command, &block) end + # Activates a pretargeting configuration. + # @param [String] name + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest] activate_pretargeting_config_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def activate_pretargeting_config(name, activate_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:activate', options) + command.request_representation = Google::Apis::RealtimebiddingV1::ActivatePretargetingConfigRequest::Representation + command.request_object = activate_pretargeting_config_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds targeted apps to the pretargeting configuration. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest] add_targeted_apps_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_pretargeting_config_targeted_apps(pretargeting_config, add_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedApps', options) + command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedAppsRequest::Representation + command.request_object = add_targeted_apps_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds targeted publishers to the pretargeting config. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest] add_targeted_publishers_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_pretargeting_config_targeted_publishers(pretargeting_config, add_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedPublishers', options) + command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedPublishersRequest::Representation + command.request_object = add_targeted_publishers_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds targeted sites to the pretargeting configuration. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest] add_targeted_sites_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_pretargeting_config_targeted_sites(pretargeting_config, add_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:addTargetedSites', options) + command.request_representation = Google::Apis::RealtimebiddingV1::AddTargetedSitesRequest::Representation + command.request_object = add_targeted_sites_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a pretargeting configuration. A pretargeting configuration's state ( + # PretargetingConfig.state) is active upon creation, and it will start to affect + # traffic shortly after. A bidder may create a maximum of 10 pretargeting + # configurations. Attempts to exceed this maximum results in a 400 bad request + # error. + # @param [String] parent + # Required. Name of the bidder to create the pretargeting configuration for. + # Format: bidders/`bidderAccountId` + # @param [Google::Apis::RealtimebiddingV1::PretargetingConfig] pretargeting_config_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_bidder_pretargeting_config(parent, pretargeting_config_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/pretargetingConfigs', options) + command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.request_object = pretargeting_config_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a pretargeting configuration. + # @param [String] name + # Required. The name of the pretargeting configuration to delete. Format: + # bidders/`bidderAccountId`/pretargetingConfig/`configId` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::RealtimebiddingV1::Empty::Representation + command.response_class = Google::Apis::RealtimebiddingV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a pretargeting configuration. + # @param [String] name + # Required. Name of the pretargeting configuration to get. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_bidder_pretargeting_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all pretargeting configurations for a single bidder. + # @param [String] parent + # Required. Name of the bidder whose pretargeting configurations will be listed. + # Format: bidders/`bidderAccountId` + # @param [Fixnum] page_size + # The maximum number of pretargeting configurations to return. If unspecified, + # at most 10 pretargeting configurations will be returned. The maximum value is + # 100; values above 100 will be coerced to 100. + # @param [String] page_token + # A token identifying a page of results the server should return. This value is + # received from a previous `ListPretargetingConfigs` call in + # ListPretargetingConfigsResponse.nextPageToken. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_pretargeting_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/pretargetingConfigs', options) + command.response_representation = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse::Representation + command.response_class = Google::Apis::RealtimebiddingV1::ListPretargetingConfigsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a pretargeting configuration. + # @param [String] name + # Output only. Name of the pretargeting configuration that must follow the + # pattern `bidders/`bidder_account_id`/pretargetingConfigs/`config_id`` + # @param [Google::Apis::RealtimebiddingV1::PretargetingConfig] pretargeting_config_object + # @param [String] update_mask + # Field mask to use for partial in-place updates. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_bidder_pretargeting_config(name, pretargeting_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.request_object = pretargeting_config_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Removes targeted apps from the pretargeting configuration. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest] remove_targeted_apps_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_pretargeting_config_targeted_apps(pretargeting_config, remove_targeted_apps_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedApps', options) + command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedAppsRequest::Representation + command.request_object = remove_targeted_apps_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Removes targeted publishers from the pretargeting config. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest] remove_targeted_publishers_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_pretargeting_config_targeted_publishers(pretargeting_config, remove_targeted_publishers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedPublishers', options) + command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedPublishersRequest::Representation + command.request_object = remove_targeted_publishers_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Removes targeted sites from the pretargeting configuration. + # @param [String] pretargeting_config + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest] remove_targeted_sites_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_pretargeting_config_targeted_sites(pretargeting_config, remove_targeted_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+pretargetingConfig}:removeTargetedSites', options) + command.request_representation = Google::Apis::RealtimebiddingV1::RemoveTargetedSitesRequest::Representation + command.request_object = remove_targeted_sites_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['pretargetingConfig'] = pretargeting_config unless pretargeting_config.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Suspends a pretargeting configuration. + # @param [String] name + # Required. The name of the pretargeting configuration. Format: bidders/` + # bidderAccountId`/pretargetingConfig/`configId` + # @param [Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest] suspend_pretargeting_config_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RealtimebiddingV1::PretargetingConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RealtimebiddingV1::PretargetingConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def suspend_pretargeting_config(name, suspend_pretargeting_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:suspend', options) + command.request_representation = Google::Apis::RealtimebiddingV1::SuspendPretargetingConfigRequest::Representation + command.request_object = suspend_pretargeting_config_request_object + command.response_representation = Google::Apis::RealtimebiddingV1::PretargetingConfig::Representation + command.response_class = Google::Apis::RealtimebiddingV1::PretargetingConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript # code that can be placed on a web page. When a user visits a page containing a # remarketing tag, Google adds the user to a user list. diff --git a/generated/google/apis/realtimebidding_v1/synth.metadata b/generated/google/apis/realtimebidding_v1/synth.metadata index 429012f74..f8312f91b 100644 --- a/generated/google/apis/realtimebidding_v1/synth.metadata +++ b/generated/google/apis/realtimebidding_v1/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "c98c719bbab68d0890524d53f8b629d7858af9c2" + "sha": "b62c09a4d05ec7b7d91daeea13a376f5f2a45dd7" } } ]