google-api-python-client 2.124.0__py2.py3-none-any.whl → 2.126.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/searchads360.v0.json

@@ -240,7 +240,7 @@
 ]
 },
 "search": {
-"description": "Returns all fields that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()",
+"description": "Returns all fields that match the search [query](/search-ads/reporting/concepts/field-service#use_a_query_to_get_field_details). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()",
 "flatPath": "v0/searchAds360Fields:search",
 "httpMethod": "POST",
 "id": "searchads360.searchAds360Fields.search",
@@ -260,7 +260,7 @@
 }
 }
 },
-"revision": "20240213",
+"revision": "20240414",
 "rootUrl": "https://searchads360.googleapis.com/",
 "schemas": {
 "GoogleAdsSearchads360V0Common__AdScheduleInfo": {
@@ -923,7 +923,7 @@
 "id": "GoogleAdsSearchads360V0Common__Metrics",
 "properties": {
 "absoluteTopImpressionPercentage": {
-"description": "The percent of your ad impressions that are shown as the very first ad above the organic search results.",
+"description": "Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.",
 "format": "double",
 "type": "number"
 },
@@ -1329,7 +1329,7 @@
 "type": "number"
 },
 "searchBudgetLostAbsoluteTopImpressionShare": {
-"description": "The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
+"description": "The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
 "format": "double",
 "type": "number"
 },
@@ -1339,7 +1339,7 @@
 "type": "number"
 },
 "searchBudgetLostTopImpressionShare": {
-"description": "The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
+"description": "The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
 "format": "double",
 "type": "number"
 },
@@ -1359,7 +1359,7 @@
 "type": "number"
 },
 "searchRankLostAbsoluteTopImpressionShare": {
-"description": "The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
+"description": "The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
 "format": "double",
 "type": "number"
 },
@@ -1369,17 +1369,17 @@
 "type": "number"
 },
 "searchRankLostTopImpressionShare": {
-"description": "The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
+"description": "The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.",
 "format": "double",
 "type": "number"
 },
 "searchTopImpressionShare": {
-"description": "The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.",
+"description": "The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries.",
 "format": "double",
 "type": "number"
 },
 "topImpressionPercentage": {
-"description": "The percent of your ad impressions that are shown anywhere above the organic search results.",
+"description": "The percent of your ad impressions that are shown adjacent to the top organic search results.",
 "format": "double",
 "type": "number"
 },
@@ -3076,6 +3076,121 @@
 },
 "type": "object"
 },
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversionValue": {
+"description": "An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversionValue",
+"properties": {
+"targetRoas": {
+"description": "Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversions": {
+"description": "An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversions",
+"properties": {
+"targetCpa": {
+"description": "Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"targetCpaMicros": {
+"description": "Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetCpa": {
+"description": "An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetCpa",
+"properties": {
+"targetCpaMicros": {
+"description": "Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetImpressionShare": {
+"description": "An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetImpressionShare",
+"properties": {
+"cpcBidCeilingMicros": {
+"description": "Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"location": {
+"description": "Output only. The targeted location on the search results page.",
+"enum": [
+"UNSPECIFIED",
+"UNKNOWN",
+"ANYWHERE_ON_PAGE",
+"TOP_OF_PAGE",
+"ABSOLUTE_TOP_OF_PAGE"
+],
+"enumDescriptions": [
+"Not specified.",
+"Used for return value only. Represents value unknown in this version.",
+"Any location on the web page.",
+"Top box of ads.",
+"Top slot in the top box of ads."
+],
+"readOnly": true,
+"type": "string"
+},
+"locationFractionMicros": {
+"description": "The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetRoas": {
+"description": "An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetRoas",
+"properties": {
+"targetRoas": {
+"description": "Output only. The chosen revenue (based on conversion data) per unit of spend.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetSpend": {
+"description": "An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.",
+"id": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetSpend",
+"properties": {
+"cpcBidCeilingMicros": {
+"description": "Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"targetSpendMicros": {
+"deprecated": true,
+"description": "Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleAdsSearchads360V0Resources_AdGroupCriterion_PositionEstimates": {
 "description": "Estimates for criterion bids at various positions.",
 "id": "GoogleAdsSearchads360V0Resources_AdGroupCriterion_PositionEstimates",
@@ -3582,6 +3697,117 @@
 },
 "type": "object"
 },
+"GoogleAdsSearchads360V0Resources__AccessibleBiddingStrategy": {
+"description": "Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.",
+"id": "GoogleAdsSearchads360V0Resources__AccessibleBiddingStrategy",
+"properties": {
+"id": {
+"description": "Output only. The ID of the bidding strategy.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"maximizeConversionValue": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversionValue",
+"description": "Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.",
+"readOnly": true
+},
+"maximizeConversions": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_MaximizeConversions",
+"description": "Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.",
+"readOnly": true
+},
+"name": {
+"description": "Output only. The name of the bidding strategy.",
+"readOnly": true,
+"type": "string"
+},
+"ownerCustomerId": {
+"description": "Output only. The ID of the Customer which owns the bidding strategy.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"ownerDescriptiveName": {
+"description": "Output only. descriptive_name of the Customer which owns the bidding strategy.",
+"readOnly": true,
+"type": "string"
+},
+"resourceName": {
+"description": "Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`",
+"readOnly": true,
+"type": "string"
+},
+"targetCpa": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetCpa",
+"description": "Output only. A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.",
+"readOnly": true
+},
+"targetImpressionShare": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetImpressionShare",
+"description": "Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.",
+"readOnly": true
+},
+"targetRoas": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetRoas",
+"description": "Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).",
+"readOnly": true
+},
+"targetSpend": {
+"$ref": "GoogleAdsSearchads360V0Resources_AccessibleBiddingStrategy_TargetSpend",
+"description": "Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.",
+"readOnly": true
+},
+"type": {
+"description": "Output only. The type of the bidding strategy.",
+"enum": [
+"UNSPECIFIED",
+"UNKNOWN",
+"COMMISSION",
+"ENHANCED_CPC",
+"INVALID",
+"MANUAL_CPA",
+"MANUAL_CPC",
+"MANUAL_CPM",
+"MANUAL_CPV",
+"MAXIMIZE_CONVERSIONS",
+"MAXIMIZE_CONVERSION_VALUE",
+"PAGE_ONE_PROMOTED",
+"PERCENT_CPC",
+"TARGET_CPA",
+"TARGET_CPM",
+"TARGET_IMPRESSION_SHARE",
+"TARGET_OUTRANK_SHARE",
+"TARGET_ROAS",
+"TARGET_SPEND"
+],
+"enumDescriptions": [
+"Not specified.",
+"Used for return value only. Represents value unknown in this version.",
+"Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.",
+"Enhanced CPC is a bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.",
+"Used for return value only. Indicates that a campaign does not have a bidding strategy. This prevents the campaign from serving. For example, a campaign may be attached to a manager bidding strategy and the serving account is subsequently unlinked from the manager account. In this case the campaign will automatically be detached from the now inaccessible manager bidding strategy and transition to the INVALID bidding strategy type.",
+"Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.",
+"Manual click based bidding where user pays per click.",
+"Manual impression based bidding where user pays per thousand impressions.",
+"A bidding strategy that pays a configurable amount per video view.",
+"A bidding strategy that automatically maximizes number of conversions given a daily budget.",
+"An automated bidding strategy that automatically sets bids to maximize revenue while spending your budget.",
+"Page-One Promoted bidding scheme, which sets max cpc bids to target impressions on page one or page one promoted slots on google.com. This enum value is deprecated.",
+"Percent Cpc is bidding strategy where bids are a fraction of the advertised price for some good or service.",
+"Target CPA is an automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.",
+"Target CPM is an automated bid strategy that sets bids to help get as many impressions as possible at the target cost per one thousand impressions (CPM) you set.",
+"An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).",
+"Target Outrank Share is an automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This enum value is deprecated.",
+"Target ROAS is an automated bidding strategy that helps you maximize revenue while averaging a specific target Return On Average Spend (ROAS).",
+"Target Spend is an automated bid strategy that sets your bids to help get as many clicks as possible within your budget."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleAdsSearchads360V0Resources__Ad": {
 "description": "An ad.",
 "id": "GoogleAdsSearchads360V0Resources__Ad",
@@ -4154,7 +4380,7 @@ false
 "type": "object"
 },
 "GoogleAdsSearchads360V0Resources__AdGroupCriterion": {
-"description": "An ad group criterion.",
+"description": "An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group.",
 "id": "GoogleAdsSearchads360V0Resources__AdGroupCriterion",
 "properties": {
 "adGroup": {
@@ -4392,7 +4618,8 @@ false
 "AUDIENCE",
 "LOCAL_SERVICE_ID",
 "BRAND",
-"BRAND_LIST"
+"BRAND_LIST",
+"LIFE_EVENT"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -4433,14 +4660,15 @@ false
 "Audience",
 "Local Services Ads Service ID.",
 "Brand",
-"Brand List"
+"Brand List",
+"Life Event"
 ],
 "readOnly": true,
 "type": "string"
 },
 "userList": {
 "$ref": "GoogleAdsSearchads360V0Common__UserListInfo",
-"description": "Immutable. User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options."
+"description": "Immutable. User List."
 },
 "webpage": {
 "$ref": "GoogleAdsSearchads360V0Common__WebpageInfo",
@@ -4832,7 +5060,8 @@ false
 "CALL_TO_ACTION_SELECTION",
 "AD_IMAGE",
 "BUSINESS_LOGO",
-"HOTEL_PROPERTY"
+"HOTEL_PROPERTY",
+"DISCOVERY_CAROUSEL_CARD"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -4863,7 +5092,8 @@ false
 "The asset is linked for use to select a call-to-action.",
 "The asset is linked for use to select an ad image.",
 "The asset is linked for use as a business logo.",
-"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign."
+"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.",
+"The asset is linked for use as a discovery carousel card."
 ],
 "type": "string"
 },
@@ -5232,6 +5462,11 @@ false
 "description": "A campaign.",
 "id": "GoogleAdsSearchads360V0Resources__Campaign",
 "properties": {
+"accessibleBiddingStrategy": {
+"description": "Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.",
+"readOnly": true,
+"type": "string"
+},
 "adServingOptimizationStatus": {
 "description": "The ad serving optimization status of the campaign.",
 "enum": [
@@ -5513,7 +5748,8 @@ false
 "CALL_TO_ACTION_SELECTION",
 "AD_IMAGE",
 "BUSINESS_LOGO",
-"HOTEL_PROPERTY"
+"HOTEL_PROPERTY",
+"DISCOVERY_CAROUSEL_CARD"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -5544,7 +5780,8 @@ false
 "The asset is linked for use to select a call-to-action.",
 "The asset is linked for use to select an ad image.",
 "The asset is linked for use as a business logo.",
-"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign."
+"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.",
+"The asset is linked for use as a discovery carousel card."
 ],
 "type": "string"
 },
@@ -5980,7 +6217,8 @@ false
 "AUDIENCE",
 "LOCAL_SERVICE_ID",
 "BRAND",
-"BRAND_LIST"
+"BRAND_LIST",
+"LIFE_EVENT"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -6021,14 +6259,15 @@ false
 "Audience",
 "Local Services Ads Service ID.",
 "Brand",
-"Brand List"
+"Brand List",
+"Life Event"
 ],
 "readOnly": true,
 "type": "string"
 },
 "userList": {
 "$ref": "GoogleAdsSearchads360V0Common__UserListInfo",
-"description": "Immutable. User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options."
+"description": "Immutable. User List."
 },
 "webpage": {
 "$ref": "GoogleAdsSearchads360V0Common__WebpageInfo",
@@ -6114,7 +6353,8 @@ false
 "CALL_TO_ACTION_SELECTION",
 "AD_IMAGE",
 "BUSINESS_LOGO",
-"HOTEL_PROPERTY"
+"HOTEL_PROPERTY",
+"DISCOVERY_CAROUSEL_CARD"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -6145,7 +6385,8 @@ false
 "The asset is linked for use to select a call-to-action.",
 "The asset is linked for use to select an ad image.",
 "The asset is linked for use as a business logo.",
-"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign."
+"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.",
+"The asset is linked for use as a discovery carousel card."
 ],
 "readOnly": true,
 "type": "string"
@@ -7153,7 +7394,7 @@ false
 "type": "object"
 },
 "GoogleAdsSearchads360V0Resources__GenderView": {
-"description": "A gender view.",
+"description": "A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.",
 "id": "GoogleAdsSearchads360V0Resources__GenderView",
 "properties": {
 "resourceName": {
@@ -7362,7 +7603,7 @@ false
 "type": "object"
 },
 "GoogleAdsSearchads360V0Resources__LocationView": {
-"description": "A location view summarizes the performance of campaigns by Location criteria.",
+"description": "A location view summarizes the performance of campaigns by a Location criterion.",
 "id": "GoogleAdsSearchads360V0Resources__LocationView",
 "properties": {
 "resourceName": {
@@ -7700,7 +7941,8 @@ false
 "CALL_TO_ACTION_SELECTION",
 "AD_IMAGE",
 "BUSINESS_LOGO",
-"HOTEL_PROPERTY"
+"HOTEL_PROPERTY",
+"DISCOVERY_CAROUSEL_CARD"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -7731,7 +7973,8 @@ false
 "The asset is linked for use to select a call-to-action.",
 "The asset is linked for use to select an ad image.",
 "The asset is linked for use as a business logo.",
-"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign."
+"The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.",
+"The asset is linked for use as a discovery carousel card."
 ],
 "readOnly": true,
 "type": "string"
@@ -7943,6 +8186,10 @@ false
 "description": "A returned row from the query.",
 "id": "GoogleAdsSearchads360V0Services__SearchAds360Row",
 "properties": {
+"accessibleBiddingStrategy": {
+"$ref": "GoogleAdsSearchads360V0Resources__AccessibleBiddingStrategy",
+"description": "The accessible bidding strategy referenced in the query."
+},
 "adGroup": {
 "$ref": "GoogleAdsSearchads360V0Resources__AdGroup",
 "description": "The ad group referenced in the query."

googleapiclient/discovery_cache/documents/searchconsole.v1.json

@@ -400,7 +400,7 @@
 }
 }
 },
-"revision": "20240324",
+"revision": "20240413",
 "rootUrl": "https://searchconsole.googleapis.com/",
 "schemas": {
 "AmpInspectionResult": {