search(customerId, body=None, x__xgafv=None)
Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
-
- searchStream(customerId, body=None, x__xgafv=None)
Returns all rows that match the search stream query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
Retrieves the next page of results.
@@ -160,12 +157,42 @@searchStream(customerId, body=None, x__xgafv=None)
- Returns all rows that match the search stream query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
-
-Args:
- customerId: string, Required. The ID of the customer being queried. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for SearchAds360Service.SearchStream.
- "batchSize": 42, # The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows.
- "query": "A String", # Required. The query string.
- "summaryRowSetting": "A String", # Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response message for SearchAds360Service.SearchStream.
- "customColumnHeaders": [ # The headers of the custom columns in the results.
- { # Message for custom column header.
- "id": "A String", # The custom column ID.
- "name": "A String", # The user defined name of the custom column.
- "referencesMetrics": True or False, # True when the custom column references metrics.
- },
- ],
- "fieldMask": "A String", # FieldMask that represents what fields were requested by the user.
- "requestId": "A String", # The unique id of the request that is used for debugging purposes.
- "results": [ # The list of rows that matched the query.
- { # A returned row from the query.
- "adGroup": { # An ad group. # The ad group referenced in the query.
- "adRotationMode": "A String", # The ad rotation mode of the ad group.
- "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid.
- "creationTime": "A String", # Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "endDate": "A String", # Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14
- "engineId": "A String", # Output only. ID of the ad group in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group.id" instead.
- "engineStatus": "A String", # Output only. The Engine Status for ad group.
- "id": "A String", # Output only. The ID of the ad group.
- "labels": [ # Output only. The resource names of labels attached to this ad group.
- "A String",
- ],
- "languageCode": "A String", # Output only. The language of the ads and keywords in an ad group. This field is only available for Microsoft Advertising accounts. More details: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "name": "A String", # The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
- "resourceName": "A String", # Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
- "startDate": "A String", # Output only. Date when this ad group starts serving ads. By default, the ad group starts now or the ad group's start date, whichever is later. If this field is set, then the ad group starts at the beginning of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14
- "status": "A String", # The status of the ad group.
- "targetingSetting": { # Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 # Setting for targeting related features.
- "targetRestrictions": [ # The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
- { # The list of per-targeting-dimension targeting settings.
- "bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
- "targetingDimension": "A String", # The targeting dimension that these settings apply to.
- },
- ],
- },
- "type": "A String", # Immutable. The type of the ad group.
- },
- "adGroupAd": { # An ad group ad. # The ad referenced in the query.
- "ad": { # An ad. # Immutable. The ad.
- "displayUrl": "A String", # The URL that appears in the ad description for some ad formats.
- "finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
- "A String",
- ],
- "id": "A String", # Output only. The ID of the ad.
- "name": "A String", # Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.
- "resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
- "type": "A String", # Output only. The type of ad.
- },
- "creationTime": "A String", # Output only. The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-SearchAds 360 entity, use "ad_group_ad.ad.id" instead.
- "engineStatus": "A String", # Output only. Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc.
- "labels": [ # Output only. The resource names of labels attached to this ad group ad.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group ad was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "resourceName": "A String", # Immutable. The resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
- "status": "A String", # The status of the ad.
- },
- "adGroupAdLabel": { # A relationship between an ad group ad and a label. # The ad group ad label referenced in the query.
- "adGroupAd": "A String", # Immutable. The ad group ad to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group ad.
- "resourceName": "A String", # Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
- },
- "adGroupAudienceView": { # An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level. # The ad group audience view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: `customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}`
- },
- "adGroupBidModifier": { # Represents an ad group bid modifier. # The bid modifier referenced in the query.
- "bidModifier": 3.14, # The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.
- "device": { # A device criterion. # Immutable. A device criterion.
- "type": "A String", # Type of the device.
- },
- "resourceName": "A String", # Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
- },
- "adGroupCriterion": { # An ad group criterion. # The criterion referenced in the query.
- "adGroup": "A String", # Immutable. The ad group to which the criterion belongs.
- "ageRange": { # An age range criterion. # Immutable. Age range.
- "type": "A String", # Type of the age range.
- },
- "bidModifier": 3.14, # The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
- "cpcBidMicros": "A String", # The CPC (cost-per-click) bid.
- "creationTime": "A String", # Output only. The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "criterionId": "A String", # Output only. The ID of the criterion.
- "effectiveCpcBidMicros": "A String", # Output only. The effective CPC (cost-per-click) bid.
- "engineId": "A String", # Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
- "engineStatus": "A String", # Output only. The Engine Status for ad group criterion.
- "finalUrlSuffix": "A String", # URL template for appending params to final URL.
- "finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
- "A String",
- ],
- "gender": { # A gender criterion. # Immutable. Gender.
- "type": "A String", # Type of the gender.
- },
- "keyword": { # A keyword criterion. # Immutable. Keyword.
- "matchType": "A String", # The match type of the keyword.
- "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
- },
- "labels": [ # Output only. The resource names of labels attached to this ad group criterion.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "listingGroup": { # A listing group criterion. # Immutable. Listing group.
- "type": "A String", # Type of the listing group.
- },
- "location": { # A location criterion. # Immutable. Location.
- "geoTargetConstant": "A String", # The geo target constant resource name.
- },
- "negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
- "qualityInfo": { # A container for ad group criterion quality information. # Output only. Information regarding the quality of the criterion.
- "qualityScore": 42, # Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
- },
- "resourceName": "A String", # Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
- "status": "A String", # The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
- "type": "A String", # Output only. The type of the criterion.
- "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # 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.
- "userList": "A String", # The User List resource name.
- },
- "webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage
- "conditions": [ # Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
- { # Logical expression for targeting webpages of an advertiser's website.
- "argument": "A String", # Argument of webpage targeting condition.
- "operand": "A String", # Operand of webpage targeting condition.
- "operator": "A String", # Operator of webpage targeting condition.
- },
- ],
- "coveragePercentage": 3.14, # Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
- "criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
- },
- },
- "adGroupCriterionLabel": { # A relationship between an ad group criterion and a label. # The ad group criterion label referenced in the query.
- "adGroupCriterion": "A String", # Immutable. The ad group criterion to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group criterion.
- "resourceName": "A String", # Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
- },
- "adGroupLabel": { # A relationship between an ad group and a label. # The ad group label referenced in the query.
- "adGroup": "A String", # Immutable. The ad group to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group.
- "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
- },
- "ageRangeView": { # An age range view. # The age range view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}`
- },
- "biddingStrategy": { # A bidding strategy. # The bidding strategy referenced in the query.
- "campaignCount": "A String", # Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
- "currencyCode": "A String", # Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
- "effectiveCurrencyCode": "A String", # Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
- "enhancedCpc": { # An automated 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. This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhanced_cpc_enabled set to true for equivalent functionality. # 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.
- },
- "id": "A String", # Output only. The ID of the bidding strategy.
- "maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetRoas": 3.14, # 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.
- },
- "maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
- },
- "name": "A String", # The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
- "nonRemovedCampaignCount": "A String", # Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
- "resourceName": "A String", # Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
- "status": "A String", # Output only. The status of the bidding strategy. This field is read-only.
- "targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
- },
- "targetImpressionShare": { # 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). # A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
- "cpcBidCeilingMicros": "A String", # 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.
- "location": "A String", # The targeted location on the search results page.
- "locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
- },
- "targetOutrankShare": { # An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This strategy is deprecated. # A bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- },
- "targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
- },
- "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # A bid strategy that sets your bids to help get as many clicks as possible within your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- "targetSpendMicros": "A String", # 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.
- },
- "type": "A String", # Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
- },
- "campaign": { # A campaign. # The campaign referenced in the query.
- "adServingOptimizationStatus": "A String", # The ad serving optimization status of the campaign.
- "advertisingChannelSubType": "A String", # Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
- "advertisingChannelType": "A String", # Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
- "biddingStrategy": "A String", # Portfolio bidding strategy used by campaign.
- "biddingStrategySystemStatus": "A String", # Output only. The system status of the campaign's bidding strategy.
- "biddingStrategyType": "A String", # Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
- "campaignBudget": "A String", # The budget of the campaign.
- "createTime": "A String", # Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead.
- "creationTime": "A String", # Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "dynamicSearchAdsSetting": { # The setting for controlling Dynamic Search Ads (DSA). # The setting for controlling Dynamic Search Ads (DSA).
- "domainName": "A String", # Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
- "languageCode": "A String", # Required. The language code specifying the language of the domain, for example, "en".
- "useSuppliedUrlsOnly": True or False, # Whether the campaign uses advertiser supplied URLs exclusively.
- },
- "endDate": "A String", # The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
- "engineId": "A String", # Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
- "excludedParentAssetFieldTypes": [ # The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
- "A String",
- ],
- "finalUrlSuffix": "A String", # Suffix used to append query parameters to landing pages that are served with parallel tracking.
- "frequencyCaps": [ # A list that limits how often each user will see this campaign's ads.
- { # A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.
- },
- ],
- "geoTargetTypeSetting": { # Represents a collection of settings related to ads geotargeting. # The setting for ads geotargeting.
- "negativeGeoTargetType": "A String", # The setting used for negative geotargeting in this particular campaign.
- "positiveGeoTargetType": "A String", # The setting used for positive geotargeting in this particular campaign.
- },
- "id": "A String", # Output only. The ID of the campaign.
- "labels": [ # Output only. The resource names of labels attached to this campaign.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "manualCpa": { # Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. # Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
- },
- "manualCpc": { # Manual click-based bidding where user pays per click. # Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
- "enhancedCpcEnabled": True or False, # Whether bids are to be enhanced based on conversion optimizer data.
- },
- "manualCpm": { # Manual impression-based bidding where user pays per thousand impressions. # Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
- },
- "maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetRoas": 3.14, # 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.
- },
- "maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
- },
- "name": "A String", # The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
- "networkSettings": { # The network settings for the campaign. # The network settings for the campaign.
- "targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
- "targetGoogleSearch": True or False, # Whether ads will be served with google.com search results.
- "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
- "targetSearchNetwork": True or False, # Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
- },
- "optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types.
- "optimizationGoalTypes": [ # The list of optimization goal types.
- "A String",
- ],
- },
- "percentCpc": { # A bidding strategy where bids are a fraction of the advertised price for some good or service. # Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
- "enhancedCpcEnabled": True or False, # Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
- },
- "realTimeBiddingSetting": { # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
- "optIn": True or False, # Whether the campaign is opted in to real-time bidding.
- },
- "resourceName": "A String", # Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
- "selectiveOptimization": { # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
- "conversionActions": [ # The selected set of conversion actions for optimizing this campaign.
- "A String",
- ],
- },
- "servingStatus": "A String", # Output only. The ad serving status of the campaign.
- "shoppingSetting": { # The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns. # The setting for controlling Shopping campaigns.
- "campaignPriority": 42, # Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
- "enableLocal": True or False, # Whether to include local products.
- "feedLabel": "A String", # Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
- "merchantId": "A String", # Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
- "salesCountry": "A String", # Sales country of products to include in the campaign.
- "useVehicleInventory": True or False, # Immutable. Whether to target Vehicle Listing inventory.
- },
- "startDate": "A String", # The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
- "status": "A String", # The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
- "targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
- },
- "targetCpm": { # Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. # A bidding strategy that automatically optimizes cost per thousand impressions.
- },
- "targetImpressionShare": { # 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 Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
- "cpcBidCeilingMicros": "A String", # 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.
- "location": "A String", # The targeted location on the search results page.
- "locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
- },
- "targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
- },
- "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- "targetSpendMicros": "A String", # 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.
- },
- "trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information.
- "trackingUrl": "A String", # Output only. The url used for dynamic tracking.
- },
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
- "urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- { # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- "key": "A String", # The key matching the parameter tag name.
- "value": "A String", # The value to be substituted.
- },
- ],
- "urlExpansionOptOut": True or False, # Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.
- },
- "campaignAudienceView": { # A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level. # The campaign audience view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}`
- },
- "campaignBudget": { # A campaign budget. # The campaign budget referenced in the query.
- "amountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.
- "deliveryMethod": "A String", # The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
- "period": "A String", # Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
- "resourceName": "A String", # Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
- },
- "campaignCriterion": { # A campaign criterion. # The campaign criterion referenced in the query.
- "ageRange": { # An age range criterion. # Immutable. Age range.
- "type": "A String", # Type of the age range.
- },
- "bidModifier": 3.14, # The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
- "criterionId": "A String", # Output only. The ID of the criterion. This field is ignored during mutate.
- "device": { # A device criterion. # Immutable. Device.
- "type": "A String", # Type of the device.
- },
- "displayName": "A String", # Output only. The display name of the criterion. This field is ignored for mutates.
- "gender": { # A gender criterion. # Immutable. Gender.
- "type": "A String", # Type of the gender.
- },
- "keyword": { # A keyword criterion. # Immutable. Keyword.
- "matchType": "A String", # The match type of the keyword.
- "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
- },
- "language": { # A language criterion. # Immutable. Language.
- "languageConstant": "A String", # The language constant resource name.
- },
- "lastModifiedTime": "A String", # Output only. The datetime when this campaign criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "location": { # A location criterion. # Immutable. Location.
- "geoTargetConstant": "A String", # The geo target constant resource name.
- },
- "locationGroup": { # A radius around a list of locations specified through a feed. # Immutable. Location Group
- "feedItemSets": [ # FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations.
- "A String",
- ],
- "geoTargetConstants": [ # Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
- "A String",
- ],
- "radius": "A String", # Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
- "radiusUnits": "A String", # Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
- },
- "negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
- "resourceName": "A String", # Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
- "status": "A String", # The status of the criterion.
- "type": "A String", # Output only. The type of the criterion.
- "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # 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.
- "userList": "A String", # The User List resource name.
- },
- "webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage.
- "conditions": [ # Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
- { # Logical expression for targeting webpages of an advertiser's website.
- "argument": "A String", # Argument of webpage targeting condition.
- "operand": "A String", # Operand of webpage targeting condition.
- "operator": "A String", # Operator of webpage targeting condition.
- },
- ],
- "coveragePercentage": 3.14, # Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
- "criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
- },
- },
- "campaignLabel": { # Represents a relationship between a campaign and a label. # The campaign label referenced in the query.
- "campaign": "A String", # Immutable. The campaign to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the campaign.
- "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
- },
- "conversionAction": { # A conversion action. # The conversion action referenced in the query.
- "appId": "A String", # App ID for an app conversion action.
- "attributionModelSettings": { # Settings related to this conversion action's attribution model. # Settings related to this conversion action's attribution model.
- "attributionModel": "A String", # The attribution model type of this conversion action.
- "dataDrivenModelStatus": "A String", # Output only. The status of the data-driven attribution model for the conversion action.
- },
- "category": "A String", # The category of conversions reported for this conversion action.
- "clickThroughLookbackWindowDays": "A String", # The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
- "creationTime": "A String", # Output only. Timestamp of the Floodlight activity's creation, formatted in ISO 8601.
- "floodlightSettings": { # Settings related to a Floodlight conversion action. # Output only. Floodlight settings for Floodlight conversion types.
- "activityGroupTag": "A String", # Output only. String used to identify a Floodlight activity group when reporting conversions.
- "activityId": "A String", # Output only. ID of the Floodlight activity in DoubleClick Campaign Manager (DCM).
- "activityTag": "A String", # Output only. String used to identify a Floodlight activity when reporting conversions.
- },
- "id": "A String", # Output only. The ID of the conversion action.
- "includeInClientAccountConversionsMetric": True or False, # Whether this conversion action should be included in the "client_account_conversions" metric.
- "includeInConversionsMetric": True or False, # Output only. Whether this conversion action should be included in the "conversions" metric.
- "name": "A String", # The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
- "ownerCustomer": "A String", # Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
- "primaryForGoal": True or False, # If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
- "resourceName": "A String", # Immutable. The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
- "status": "A String", # The status of this conversion action for conversion event accrual.
- "type": "A String", # Immutable. The type of this conversion action.
- "valueSettings": { # Settings related to the value for conversion events associated with this conversion action. # Settings related to the value for conversion events associated with this conversion action.
- "alwaysUseDefaultValue": True or False, # Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
- "defaultCurrencyCode": "A String", # The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
- "defaultValue": 3.14, # The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
- },
- },
- "customColumns": [ # The custom columns.
- { # A generic data container.
- "booleanValue": True or False, # A boolean.
- "doubleValue": 3.14, # A double.
- "floatValue": 3.14, # A float.
- "int64Value": "A String", # An int64.
- "stringValue": "A String", # A string.
- },
- ],
- "customer": { # A customer. # The customer referenced in the query.
- "accountStatus": "A String", # Output only. Account status, for example, Enabled, Paused, Removed, etc.
- "accountType": "A String", # Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.
- "autoTaggingEnabled": True or False, # Whether auto-tagging is enabled for the customer.
- "conversionTrackingSetting": { # A collection of customer-wide settings related to Search Ads 360 Conversion Tracking. # Output only. Conversion tracking setting for a customer.
- "acceptedCustomerDataTerms": True or False, # Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
- "conversionTrackingId": "A String", # Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
- "conversionTrackingStatus": "A String", # Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
- "crossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.
- "enhancedConversionsForLeadsEnabled": True or False, # Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
- "googleAdsConversionCustomer": "A String", # Output only. The resource name of the customer where conversions are created and managed. This field is read-only.
- "googleAdsCrossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
- },
- "creationTime": "A String", # Output only. The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "currencyCode": "A String", # Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
- "descriptiveName": "A String", # Optional, non-unique descriptive name of the customer.
- "doubleClickCampaignManagerSetting": { # DoubleClick Campaign Manager (DCM) setting for a manager customer. # Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer.
- "advertiserId": "A String", # Output only. ID of the Campaign Manager advertiser associated with this customer.
- "networkId": "A String", # Output only. ID of the Campaign Manager network associated with this customer.
- "timeZone": "A String", # Output only. Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.
- },
- "engineId": "A String", # Output only. ID of the account in the external engine account.
- "finalUrlSuffix": "A String", # The URL template for appending params to the final URL.
- "id": "A String", # Output only. The ID of the customer.
- "lastModifiedTime": "A String", # Output only. The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "manager": True or False, # Output only. Whether the customer is a manager.
- "resourceName": "A String", # Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
- "status": "A String", # Output only. The status of the customer.
- "timeZone": "A String", # Immutable. The local timezone ID of the customer.
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL out of parameters.
- },
- "customerClient": { # A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself. # The CustomerClient referenced in the query.
- "appliedLabels": [ # Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
- "A String",
- ],
- "clientCustomer": "A String", # Output only. The resource name of the client-customer which is linked to the given customer. Read only.
- "currencyCode": "A String", # Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
- "descriptiveName": "A String", # Output only. Descriptive name for the client. Read only.
- "hidden": True or False, # Output only. Specifies whether this is a hidden account. Read only.
- "id": "A String", # Output only. The ID of the client customer. Read only.
- "level": "A String", # Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
- "manager": True or False, # Output only. Identifies if the client is a manager. Read only.
- "resourceName": "A String", # Output only. The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
- "status": "A String", # Output only. The status of the client customer. Read only.
- "testAccount": True or False, # Output only. Identifies if the client is a test account. Read only.
- "timeZone": "A String", # Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
- },
- "customerManagerLink": { # Represents customer-manager link relationship. # The CustomerManagerLink referenced in the query.
- "managerCustomer": "A String", # Output only. The manager customer linked to the customer.
- "managerLinkId": "A String", # Output only. ID of the customer-manager link. This field is read only.
- "resourceName": "A String", # Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
- "status": "A String", # Status of the link between the customer and the manager.
- },
- "dynamicSearchAdsSearchTermView": { # A dynamic search ads search term view. # The dynamic search ads search term view referenced in the query.
- "landingPage": "A String", # Output only. The dynamically selected landing page URL of the impression. This field is read-only.
- "resourceName": "A String", # Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}`
- },
- "genderView": { # A gender view. # The gender view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}`
- },
- "keywordView": { # A keyword view. # The keyword view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the keyword view. Keyword view resource names have the form: `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}`
- },
- "label": { # A label. # The label referenced in the query.
- "id": "A String", # Output only. ID of the label. Read only.
- "name": "A String", # The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
- "resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
- "status": "A String", # Output only. Status of the label. Read only.
- "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background.
- "backgroundColor": "A String", # Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
- "description": "A String", # A short description of the label. The length must be no more than 200 characters.
- },
- },
- "locationView": { # A location view summarizes the performance of campaigns by Location criteria. # The location view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}`
- },
- "metrics": { # Metrics data. # The metrics.
- "absoluteTopImpressionPercentage": 3.14, # The percent of your ad impressions that are shown as the very first ad above the organic search results.
- "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
- "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
- "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
- "allConversionsFromInteractionsValuePerInteraction": 3.14, # The value of all conversions from interactions divided by the total number of interactions.
- "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
- "allConversionsFromOrder": 3.14, # The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
- "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
- "allConversionsValue": 3.14, # The value of all conversions.
- "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
- "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
- "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received.
- "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM).
- "clicks": "A String", # The number of clicks.
- "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
- "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "contentImpressionShare": 3.14, # The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "contentRankLostImpressionShare": 3.14, # The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.
- "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion.
- "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions.
- "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date.
- "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions.
- "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
- "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions.
- "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion.
- "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
- "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions.
- "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
- "historicalCreativeQualityScore": "A String", # The creative historical quality score.
- "historicalLandingPageQualityScore": "A String", # The quality of historical landing page experience.
- "historicalQualityScore": "A String", # The historical quality score.
- "historicalSearchPredictedCtr": "A String", # The historical search predicted click through rate (CTR).
- "impressions": "A String", # Count of how often your ad has appeared on a search results page or website on the Google Network.
- "interactionEventTypes": [ # The types of payable and free interactions.
- "A String",
- ],
- "interactionRate": 3.14, # How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
- "interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
- "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
- "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for.
- "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page.
- "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.
- "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # 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.
- "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "searchBudgetLostTopImpressionShare": 3.14, # 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.
- "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchRankLostAbsoluteTopImpressionShare": 3.14, # 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.
- "searchRankLostImpressionShare": 3.14, # The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "searchRankLostTopImpressionShare": 3.14, # 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.
- "searchTopImpressionShare": 3.14, # 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.
- "topImpressionPercentage": 3.14, # The percent of your ad impressions that are shown anywhere above the organic search results.
- "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions.
- "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth.
- "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date.
- "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page.
- },
- "productGroupView": { # A product group view. # The product group view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}`
- },
- "segments": { # Segment only fields. # The segments.
- "conversionAction": "A String", # Resource name of the conversion action.
- "conversionActionCategory": "A String", # Conversion action category.
- "conversionActionName": "A String", # Conversion action name.
- "date": "A String", # Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
- "dayOfWeek": "A String", # Day of the week, for example, MONDAY.
- "device": "A String", # Device to which metrics apply.
- "month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
- "quarter": "A String", # Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
- "week": "A String", # Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
- "year": 42, # Year, formatted as yyyy.
- },
- "userList": { # A user list. This is a list of users a customer may target. # The user list referenced in the query.
- "id": "A String", # Output only. Id of the user list.
- "name": "A String", # Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
- "resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
- "type": "A String", # Output only. Type of this list. This field is read-only.
- },
- "webpageView": { # A webpage view. # The webpage view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the webpage view. Webpage view resource names have the form: `customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}`
- },
- },
- ],
- "summaryRow": { # A returned row from the query. # Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc.
- "adGroup": { # An ad group. # The ad group referenced in the query.
- "adRotationMode": "A String", # The ad rotation mode of the ad group.
- "cpcBidMicros": "A String", # The maximum CPC (cost-per-click) bid.
- "creationTime": "A String", # Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "endDate": "A String", # Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14
- "engineId": "A String", # Output only. ID of the ad group in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group.id" instead.
- "engineStatus": "A String", # Output only. The Engine Status for ad group.
- "id": "A String", # Output only. The ID of the ad group.
- "labels": [ # Output only. The resource names of labels attached to this ad group.
- "A String",
- ],
- "languageCode": "A String", # Output only. The language of the ads and keywords in an ad group. This field is only available for Microsoft Advertising accounts. More details: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "name": "A String", # The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
- "resourceName": "A String", # Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
- "startDate": "A String", # Output only. Date when this ad group starts serving ads. By default, the ad group starts now or the ad group's start date, whichever is later. If this field is set, then the ad group starts at the beginning of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14
- "status": "A String", # The status of the ad group.
- "targetingSetting": { # Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 # Setting for targeting related features.
- "targetRestrictions": [ # The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
- { # The list of per-targeting-dimension targeting settings.
- "bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
- "targetingDimension": "A String", # The targeting dimension that these settings apply to.
- },
- ],
- },
- "type": "A String", # Immutable. The type of the ad group.
- },
- "adGroupAd": { # An ad group ad. # The ad referenced in the query.
- "ad": { # An ad. # Immutable. The ad.
- "displayUrl": "A String", # The URL that appears in the ad description for some ad formats.
- "finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
- "A String",
- ],
- "id": "A String", # Output only. The ID of the ad.
- "name": "A String", # Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.
- "resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
- "type": "A String", # Output only. The type of ad.
- },
- "creationTime": "A String", # Output only. The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-SearchAds 360 entity, use "ad_group_ad.ad.id" instead.
- "engineStatus": "A String", # Output only. Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc.
- "labels": [ # Output only. The resource names of labels attached to this ad group ad.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group ad was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "resourceName": "A String", # Immutable. The resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
- "status": "A String", # The status of the ad.
- },
- "adGroupAdLabel": { # A relationship between an ad group ad and a label. # The ad group ad label referenced in the query.
- "adGroupAd": "A String", # Immutable. The ad group ad to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group ad.
- "resourceName": "A String", # Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
- },
- "adGroupAudienceView": { # An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level. # The ad group audience view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: `customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}`
- },
- "adGroupBidModifier": { # Represents an ad group bid modifier. # The bid modifier referenced in the query.
- "bidModifier": 3.14, # The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.
- "device": { # A device criterion. # Immutable. A device criterion.
- "type": "A String", # Type of the device.
- },
- "resourceName": "A String", # Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
- },
- "adGroupCriterion": { # An ad group criterion. # The criterion referenced in the query.
- "adGroup": "A String", # Immutable. The ad group to which the criterion belongs.
- "ageRange": { # An age range criterion. # Immutable. Age range.
- "type": "A String", # Type of the age range.
- },
- "bidModifier": 3.14, # The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
- "cpcBidMicros": "A String", # The CPC (cost-per-click) bid.
- "creationTime": "A String", # Output only. The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "criterionId": "A String", # Output only. The ID of the criterion.
- "effectiveCpcBidMicros": "A String", # Output only. The effective CPC (cost-per-click) bid.
- "engineId": "A String", # Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
- "engineStatus": "A String", # Output only. The Engine Status for ad group criterion.
- "finalUrlSuffix": "A String", # URL template for appending params to final URL.
- "finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
- "A String",
- ],
- "gender": { # A gender criterion. # Immutable. Gender.
- "type": "A String", # Type of the gender.
- },
- "keyword": { # A keyword criterion. # Immutable. Keyword.
- "matchType": "A String", # The match type of the keyword.
- "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
- },
- "labels": [ # Output only. The resource names of labels attached to this ad group criterion.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "listingGroup": { # A listing group criterion. # Immutable. Listing group.
- "type": "A String", # Type of the listing group.
- },
- "location": { # A location criterion. # Immutable. Location.
- "geoTargetConstant": "A String", # The geo target constant resource name.
- },
- "negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
- "qualityInfo": { # A container for ad group criterion quality information. # Output only. Information regarding the quality of the criterion.
- "qualityScore": 42, # Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
- },
- "resourceName": "A String", # Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
- "status": "A String", # The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
- "type": "A String", # Output only. The type of the criterion.
- "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # 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.
- "userList": "A String", # The User List resource name.
- },
- "webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage
- "conditions": [ # Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
- { # Logical expression for targeting webpages of an advertiser's website.
- "argument": "A String", # Argument of webpage targeting condition.
- "operand": "A String", # Operand of webpage targeting condition.
- "operator": "A String", # Operator of webpage targeting condition.
- },
- ],
- "coveragePercentage": 3.14, # Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
- "criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
- },
- },
- "adGroupCriterionLabel": { # A relationship between an ad group criterion and a label. # The ad group criterion label referenced in the query.
- "adGroupCriterion": "A String", # Immutable. The ad group criterion to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group criterion.
- "resourceName": "A String", # Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
- },
- "adGroupLabel": { # A relationship between an ad group and a label. # The ad group label referenced in the query.
- "adGroup": "A String", # Immutable. The ad group to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the ad group.
- "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
- },
- "ageRangeView": { # An age range view. # The age range view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}`
- },
- "biddingStrategy": { # A bidding strategy. # The bidding strategy referenced in the query.
- "campaignCount": "A String", # Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
- "currencyCode": "A String", # Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
- "effectiveCurrencyCode": "A String", # Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
- "enhancedCpc": { # An automated 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. This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhanced_cpc_enabled set to true for equivalent functionality. # 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.
- },
- "id": "A String", # Output only. The ID of the bidding strategy.
- "maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetRoas": 3.14, # 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.
- },
- "maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
- },
- "name": "A String", # The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
- "nonRemovedCampaignCount": "A String", # Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
- "resourceName": "A String", # Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
- "status": "A String", # Output only. The status of the bidding strategy. This field is read-only.
- "targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
- },
- "targetImpressionShare": { # 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). # A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
- "cpcBidCeilingMicros": "A String", # 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.
- "location": "A String", # The targeted location on the search results page.
- "locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
- },
- "targetOutrankShare": { # An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This strategy is deprecated. # A bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- },
- "targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
- },
- "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # A bid strategy that sets your bids to help get as many clicks as possible within your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- "targetSpendMicros": "A String", # 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.
- },
- "type": "A String", # Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
- },
- "campaign": { # A campaign. # The campaign referenced in the query.
- "adServingOptimizationStatus": "A String", # The ad serving optimization status of the campaign.
- "advertisingChannelSubType": "A String", # Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
- "advertisingChannelType": "A String", # Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
- "biddingStrategy": "A String", # Portfolio bidding strategy used by campaign.
- "biddingStrategySystemStatus": "A String", # Output only. The system status of the campaign's bidding strategy.
- "biddingStrategyType": "A String", # Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
- "campaignBudget": "A String", # The budget of the campaign.
- "createTime": "A String", # Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead.
- "creationTime": "A String", # Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "dynamicSearchAdsSetting": { # The setting for controlling Dynamic Search Ads (DSA). # The setting for controlling Dynamic Search Ads (DSA).
- "domainName": "A String", # Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
- "languageCode": "A String", # Required. The language code specifying the language of the domain, for example, "en".
- "useSuppliedUrlsOnly": True or False, # Whether the campaign uses advertiser supplied URLs exclusively.
- },
- "endDate": "A String", # The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
- "engineId": "A String", # Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
- "excludedParentAssetFieldTypes": [ # The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
- "A String",
- ],
- "finalUrlSuffix": "A String", # Suffix used to append query parameters to landing pages that are served with parallel tracking.
- "frequencyCaps": [ # A list that limits how often each user will see this campaign's ads.
- { # A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.
- },
- ],
- "geoTargetTypeSetting": { # Represents a collection of settings related to ads geotargeting. # The setting for ads geotargeting.
- "negativeGeoTargetType": "A String", # The setting used for negative geotargeting in this particular campaign.
- "positiveGeoTargetType": "A String", # The setting used for positive geotargeting in this particular campaign.
- },
- "id": "A String", # Output only. The ID of the campaign.
- "labels": [ # Output only. The resource names of labels attached to this campaign.
- "A String",
- ],
- "lastModifiedTime": "A String", # Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "manualCpa": { # Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. # Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
- },
- "manualCpc": { # Manual click-based bidding where user pays per click. # Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
- "enhancedCpcEnabled": True or False, # Whether bids are to be enhanced based on conversion optimizer data.
- },
- "manualCpm": { # Manual impression-based bidding where user pays per thousand impressions. # Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
- },
- "maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetRoas": 3.14, # 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.
- },
- "maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
- "targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
- },
- "name": "A String", # The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
- "networkSettings": { # The network settings for the campaign. # The network settings for the campaign.
- "targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
- "targetGoogleSearch": True or False, # Whether ads will be served with google.com search results.
- "targetPartnerSearchNetwork": True or False, # Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
- "targetSearchNetwork": True or False, # Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
- },
- "optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types.
- "optimizationGoalTypes": [ # The list of optimization goal types.
- "A String",
- ],
- },
- "percentCpc": { # A bidding strategy where bids are a fraction of the advertised price for some good or service. # Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
- "enhancedCpcEnabled": True or False, # Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
- },
- "realTimeBiddingSetting": { # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
- "optIn": True or False, # Whether the campaign is opted in to real-time bidding.
- },
- "resourceName": "A String", # Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
- "selectiveOptimization": { # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
- "conversionActions": [ # The selected set of conversion actions for optimizing this campaign.
- "A String",
- ],
- },
- "servingStatus": "A String", # Output only. The ad serving status of the campaign.
- "shoppingSetting": { # The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns. # The setting for controlling Shopping campaigns.
- "campaignPriority": 42, # Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
- "enableLocal": True or False, # Whether to include local products.
- "feedLabel": "A String", # Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
- "merchantId": "A String", # Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
- "salesCountry": "A String", # Sales country of products to include in the campaign.
- "useVehicleInventory": True or False, # Immutable. Whether to target Vehicle Listing inventory.
- },
- "startDate": "A String", # The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
- "status": "A String", # The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
- "targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
- },
- "targetCpm": { # Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. # A bidding strategy that automatically optimizes cost per thousand impressions.
- },
- "targetImpressionShare": { # 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 Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
- "cpcBidCeilingMicros": "A String", # 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.
- "location": "A String", # The targeted location on the search results page.
- "locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
- },
- "targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
- "targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
- },
- "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
- "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
- "targetSpendMicros": "A String", # 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.
- },
- "trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information.
- "trackingUrl": "A String", # Output only. The url used for dynamic tracking.
- },
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
- "urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- { # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- "key": "A String", # The key matching the parameter tag name.
- "value": "A String", # The value to be substituted.
- },
- ],
- "urlExpansionOptOut": True or False, # Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.
- },
- "campaignAudienceView": { # A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level. # The campaign audience view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}`
- },
- "campaignBudget": { # A campaign budget. # The campaign budget referenced in the query.
- "amountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.
- "deliveryMethod": "A String", # The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
- "period": "A String", # Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
- "resourceName": "A String", # Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
- },
- "campaignCriterion": { # A campaign criterion. # The campaign criterion referenced in the query.
- "ageRange": { # An age range criterion. # Immutable. Age range.
- "type": "A String", # Type of the age range.
- },
- "bidModifier": 3.14, # The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
- "criterionId": "A String", # Output only. The ID of the criterion. This field is ignored during mutate.
- "device": { # A device criterion. # Immutable. Device.
- "type": "A String", # Type of the device.
- },
- "displayName": "A String", # Output only. The display name of the criterion. This field is ignored for mutates.
- "gender": { # A gender criterion. # Immutable. Gender.
- "type": "A String", # Type of the gender.
- },
- "keyword": { # A keyword criterion. # Immutable. Keyword.
- "matchType": "A String", # The match type of the keyword.
- "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
- },
- "language": { # A language criterion. # Immutable. Language.
- "languageConstant": "A String", # The language constant resource name.
- },
- "lastModifiedTime": "A String", # Output only. The datetime when this campaign criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "location": { # A location criterion. # Immutable. Location.
- "geoTargetConstant": "A String", # The geo target constant resource name.
- },
- "locationGroup": { # A radius around a list of locations specified through a feed. # Immutable. Location Group
- "feedItemSets": [ # FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations.
- "A String",
- ],
- "geoTargetConstants": [ # Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
- "A String",
- ],
- "radius": "A String", # Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
- "radiusUnits": "A String", # Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
- },
- "negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
- "resourceName": "A String", # Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
- "status": "A String", # The status of the criterion.
- "type": "A String", # Output only. The type of the criterion.
- "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # 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.
- "userList": "A String", # The User List resource name.
- },
- "webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage.
- "conditions": [ # Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
- { # Logical expression for targeting webpages of an advertiser's website.
- "argument": "A String", # Argument of webpage targeting condition.
- "operand": "A String", # Operand of webpage targeting condition.
- "operator": "A String", # Operator of webpage targeting condition.
- },
- ],
- "coveragePercentage": 3.14, # Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
- "criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
- },
- },
- "campaignLabel": { # Represents a relationship between a campaign and a label. # The campaign label referenced in the query.
- "campaign": "A String", # Immutable. The campaign to which the label is attached.
- "label": "A String", # Immutable. The label assigned to the campaign.
- "resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
- },
- "conversionAction": { # A conversion action. # The conversion action referenced in the query.
- "appId": "A String", # App ID for an app conversion action.
- "attributionModelSettings": { # Settings related to this conversion action's attribution model. # Settings related to this conversion action's attribution model.
- "attributionModel": "A String", # The attribution model type of this conversion action.
- "dataDrivenModelStatus": "A String", # Output only. The status of the data-driven attribution model for the conversion action.
- },
- "category": "A String", # The category of conversions reported for this conversion action.
- "clickThroughLookbackWindowDays": "A String", # The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
- "creationTime": "A String", # Output only. Timestamp of the Floodlight activity's creation, formatted in ISO 8601.
- "floodlightSettings": { # Settings related to a Floodlight conversion action. # Output only. Floodlight settings for Floodlight conversion types.
- "activityGroupTag": "A String", # Output only. String used to identify a Floodlight activity group when reporting conversions.
- "activityId": "A String", # Output only. ID of the Floodlight activity in DoubleClick Campaign Manager (DCM).
- "activityTag": "A String", # Output only. String used to identify a Floodlight activity when reporting conversions.
- },
- "id": "A String", # Output only. The ID of the conversion action.
- "includeInClientAccountConversionsMetric": True or False, # Whether this conversion action should be included in the "client_account_conversions" metric.
- "includeInConversionsMetric": True or False, # Output only. Whether this conversion action should be included in the "conversions" metric.
- "name": "A String", # The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
- "ownerCustomer": "A String", # Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
- "primaryForGoal": True or False, # If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
- "resourceName": "A String", # Immutable. The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
- "status": "A String", # The status of this conversion action for conversion event accrual.
- "type": "A String", # Immutable. The type of this conversion action.
- "valueSettings": { # Settings related to the value for conversion events associated with this conversion action. # Settings related to the value for conversion events associated with this conversion action.
- "alwaysUseDefaultValue": True or False, # Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
- "defaultCurrencyCode": "A String", # The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
- "defaultValue": 3.14, # The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
- },
- },
- "customColumns": [ # The custom columns.
- { # A generic data container.
- "booleanValue": True or False, # A boolean.
- "doubleValue": 3.14, # A double.
- "floatValue": 3.14, # A float.
- "int64Value": "A String", # An int64.
- "stringValue": "A String", # A string.
- },
- ],
- "customer": { # A customer. # The customer referenced in the query.
- "accountStatus": "A String", # Output only. Account status, for example, Enabled, Paused, Removed, etc.
- "accountType": "A String", # Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.
- "autoTaggingEnabled": True or False, # Whether auto-tagging is enabled for the customer.
- "conversionTrackingSetting": { # A collection of customer-wide settings related to Search Ads 360 Conversion Tracking. # Output only. Conversion tracking setting for a customer.
- "acceptedCustomerDataTerms": True or False, # Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
- "conversionTrackingId": "A String", # Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
- "conversionTrackingStatus": "A String", # Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
- "crossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.
- "enhancedConversionsForLeadsEnabled": True or False, # Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
- "googleAdsConversionCustomer": "A String", # Output only. The resource name of the customer where conversions are created and managed. This field is read-only.
- "googleAdsCrossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
- },
- "creationTime": "A String", # Output only. The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
- "currencyCode": "A String", # Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
- "descriptiveName": "A String", # Optional, non-unique descriptive name of the customer.
- "doubleClickCampaignManagerSetting": { # DoubleClick Campaign Manager (DCM) setting for a manager customer. # Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer.
- "advertiserId": "A String", # Output only. ID of the Campaign Manager advertiser associated with this customer.
- "networkId": "A String", # Output only. ID of the Campaign Manager network associated with this customer.
- "timeZone": "A String", # Output only. Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.
- },
- "engineId": "A String", # Output only. ID of the account in the external engine account.
- "finalUrlSuffix": "A String", # The URL template for appending params to the final URL.
- "id": "A String", # Output only. The ID of the customer.
- "lastModifiedTime": "A String", # Output only. The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
- "manager": True or False, # Output only. Whether the customer is a manager.
- "resourceName": "A String", # Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
- "status": "A String", # Output only. The status of the customer.
- "timeZone": "A String", # Immutable. The local timezone ID of the customer.
- "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL out of parameters.
- },
- "customerClient": { # A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself. # The CustomerClient referenced in the query.
- "appliedLabels": [ # Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
- "A String",
- ],
- "clientCustomer": "A String", # Output only. The resource name of the client-customer which is linked to the given customer. Read only.
- "currencyCode": "A String", # Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
- "descriptiveName": "A String", # Output only. Descriptive name for the client. Read only.
- "hidden": True or False, # Output only. Specifies whether this is a hidden account. Read only.
- "id": "A String", # Output only. The ID of the client customer. Read only.
- "level": "A String", # Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
- "manager": True or False, # Output only. Identifies if the client is a manager. Read only.
- "resourceName": "A String", # Output only. The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
- "status": "A String", # Output only. The status of the client customer. Read only.
- "testAccount": True or False, # Output only. Identifies if the client is a test account. Read only.
- "timeZone": "A String", # Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
- },
- "customerManagerLink": { # Represents customer-manager link relationship. # The CustomerManagerLink referenced in the query.
- "managerCustomer": "A String", # Output only. The manager customer linked to the customer.
- "managerLinkId": "A String", # Output only. ID of the customer-manager link. This field is read only.
- "resourceName": "A String", # Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
- "status": "A String", # Status of the link between the customer and the manager.
- },
- "dynamicSearchAdsSearchTermView": { # A dynamic search ads search term view. # The dynamic search ads search term view referenced in the query.
- "landingPage": "A String", # Output only. The dynamically selected landing page URL of the impression. This field is read-only.
- "resourceName": "A String", # Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}`
- },
- "genderView": { # A gender view. # The gender view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}`
- },
- "keywordView": { # A keyword view. # The keyword view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the keyword view. Keyword view resource names have the form: `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}`
- },
- "label": { # A label. # The label referenced in the query.
- "id": "A String", # Output only. ID of the label. Read only.
- "name": "A String", # The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
- "resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
- "status": "A String", # Output only. Status of the label. Read only.
- "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background.
- "backgroundColor": "A String", # Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
- "description": "A String", # A short description of the label. The length must be no more than 200 characters.
- },
- },
- "locationView": { # A location view summarizes the performance of campaigns by Location criteria. # The location view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}`
- },
- "metrics": { # Metrics data. # The metrics.
- "absoluteTopImpressionPercentage": 3.14, # The percent of your ad impressions that are shown as the very first ad above the organic search results.
- "allConversions": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
- "allConversionsByConversionDate": 3.14, # The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "allConversionsFromClickToCall": 3.14, # The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
- "allConversionsFromDirections": 3.14, # The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromInteractionsRate": 3.14, # All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
- "allConversionsFromInteractionsValuePerInteraction": 3.14, # The value of all conversions from interactions divided by the total number of interactions.
- "allConversionsFromMenu": 3.14, # The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
- "allConversionsFromOrder": 3.14, # The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromOtherEngagement": 3.14, # The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
- "allConversionsFromStoreVisit": 3.14, # Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
- "allConversionsFromStoreWebsite": 3.14, # The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
- "allConversionsValue": 3.14, # The value of all conversions.
- "allConversionsValueByConversionDate": 3.14, # The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "allConversionsValuePerCost": 3.14, # The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
- "averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
- "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received.
- "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM).
- "clicks": "A String", # The number of clicks.
- "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "clientAccountViewThroughConversions": "A String", # The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
- "contentBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "contentImpressionShare": 3.14, # The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "contentRankLostImpressionShare": 3.14, # The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "conversions": 3.14, # The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "conversionsByConversionDate": 3.14, # The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.
- "conversionsFromInteractionsRate": 3.14, # Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion.
- "conversionsFromInteractionsValuePerInteraction": 3.14, # The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "conversionsValue": 3.14, # The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions.
- "conversionsValueByConversionDate": 3.14, # The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date.
- "conversionsValuePerCost": 3.14, # The value of biddable conversion divided by the total cost of conversion eligible interactions.
- "costMicros": "A String", # The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
- "costPerAllConversions": 3.14, # The cost of ad interactions divided by all conversions.
- "costPerConversion": 3.14, # Average conversion eligible cost per biddable conversion.
- "costPerCurrentModelAttributedConversion": 3.14, # The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
- "crossDeviceConversions": 3.14, # Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
- "crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions.
- "ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
- "historicalCreativeQualityScore": "A String", # The creative historical quality score.
- "historicalLandingPageQualityScore": "A String", # The quality of historical landing page experience.
- "historicalQualityScore": "A String", # The historical quality score.
- "historicalSearchPredictedCtr": "A String", # The historical search predicted click through rate (CTR).
- "impressions": "A String", # Count of how often your ad has appeared on a search results page or website on the Google Network.
- "interactionEventTypes": [ # The types of payable and free interactions.
- "A String",
- ],
- "interactionRate": 3.14, # How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
- "interactions": "A String", # The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
- "invalidClickRate": 3.14, # The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
- "invalidClicks": "A String", # Number of clicks Google considers illegitimate and doesn't charge you for.
- "mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page.
- "searchAbsoluteTopImpressionShare": 3.14, # The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.
- "searchBudgetLostAbsoluteTopImpressionShare": 3.14, # 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.
- "searchBudgetLostImpressionShare": 3.14, # The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "searchBudgetLostTopImpressionShare": 3.14, # 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.
- "searchClickShare": 3.14, # The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchExactMatchImpressionShare": 3.14, # The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchImpressionShare": 3.14, # The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
- "searchRankLostAbsoluteTopImpressionShare": 3.14, # 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.
- "searchRankLostImpressionShare": 3.14, # The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
- "searchRankLostTopImpressionShare": 3.14, # 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.
- "searchTopImpressionShare": 3.14, # 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.
- "topImpressionPercentage": 3.14, # The percent of your ad impressions that are shown anywhere above the organic search results.
- "valuePerAllConversions": 3.14, # The value of all conversions divided by the number of all conversions.
- "valuePerAllConversionsByConversionDate": 3.14, # The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
- "valuePerConversion": 3.14, # The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth.
- "valuePerConversionsByConversionDate": 3.14, # Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date.
- "visits": 3.14, # Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page.
- },
- "productGroupView": { # A product group view. # The product group view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}`
- },
- "segments": { # Segment only fields. # The segments.
- "conversionAction": "A String", # Resource name of the conversion action.
- "conversionActionCategory": "A String", # Conversion action category.
- "conversionActionName": "A String", # Conversion action name.
- "date": "A String", # Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
- "dayOfWeek": "A String", # Day of the week, for example, MONDAY.
- "device": "A String", # Device to which metrics apply.
- "month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
- "quarter": "A String", # Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
- "week": "A String", # Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
- "year": 42, # Year, formatted as yyyy.
- },
- "userList": { # A user list. This is a list of users a customer may target. # The user list referenced in the query.
- "id": "A String", # Output only. Id of the user list.
- "name": "A String", # Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
- "resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
- "type": "A String", # Output only. Type of this list. This field is read-only.
- },
- "webpageView": { # A webpage view. # The webpage view referenced in the query.
- "resourceName": "A String", # Output only. The resource name of the webpage view. Webpage view resource names have the form: `customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}`
- },
- },
-}
-search_next()
Retrieves the next page of results.
diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json
index dccbad60400..af8cfe2a064 100644
--- a/googleapiclient/discovery_cache/documents/searchads360.v0.json
+++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json
@@ -190,34 +190,6 @@
"scopes": [
"https://www.googleapis.com/auth/doubleclicksearch"
]
- },
- "searchStream": {
- "description": "Returns all rows that match the search stream query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()",
- "flatPath": "v0/customers/{customersId}/searchAds360:searchStream",
- "httpMethod": "POST",
- "id": "searchads360.customers.searchAds360.searchStream",
- "parameterOrder": [
- "customerId"
- ],
- "parameters": {
- "customerId": {
- "description": "Required. The ID of the customer being queried.",
- "location": "path",
- "pattern": "^[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v0/customers/{+customerId}/searchAds360:searchStream",
- "request": {
- "$ref": "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamRequest"
- },
- "response": {
- "$ref": "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/doubleclicksearch"
- ]
}
}
}
@@ -271,7 +243,7 @@
}
}
},
- "revision": "20230405",
+ "revision": "20230504",
"rootUrl": "https://searchads360.googleapis.com/",
"schemas": {
"GoogleAdsSearchads360V0Common__AgeRangeInfo": {
@@ -388,6 +360,21 @@
},
"type": "object"
},
+ "GoogleAdsSearchads360V0Common__Keyword": {
+ "description": "A Keyword criterion segment.",
+ "id": "GoogleAdsSearchads360V0Common__Keyword",
+ "properties": {
+ "adGroupCriterion": {
+ "description": "The AdGroupCriterion resource name.",
+ "type": "string"
+ },
+ "info": {
+ "$ref": "GoogleAdsSearchads360V0Common__KeywordInfo",
+ "description": "Keyword info."
+ }
+ },
+ "type": "object"
+ },
"GoogleAdsSearchads360V0Common__KeywordInfo": {
"description": "A keyword criterion.",
"id": "GoogleAdsSearchads360V0Common__KeywordInfo",
@@ -999,6 +986,124 @@
},
"type": "object"
},
+ "GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo": {
+ "description": "An expanded dynamic search ad.",
+ "id": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo",
+ "properties": {
+ "adTrackingId": {
+ "description": "The tracking id of the ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description1": {
+ "description": "The first line of the ad's description.",
+ "type": "string"
+ },
+ "description2": {
+ "description": "The second line of the ad's description.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo": {
+ "description": "A Search Ads 360 expanded text ad.",
+ "id": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo",
+ "properties": {
+ "adTrackingId": {
+ "description": "The tracking id of the ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description1": {
+ "description": "The first line of the ad's description.",
+ "type": "string"
+ },
+ "description2": {
+ "description": "The second line of the ad's description.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "The headline of the ad.",
+ "type": "string"
+ },
+ "headline2": {
+ "description": "The second headline of the ad.",
+ "type": "string"
+ },
+ "headline3": {
+ "description": "The third headline of the ad.",
+ "type": "string"
+ },
+ "path1": {
+ "description": "Text appended to the auto-generated visible URL with a delimiter.",
+ "type": "string"
+ },
+ "path2": {
+ "description": "Text appended to path1 with a delimiter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleAdsSearchads360V0Common__SearchAds360ProductAdInfo": {
+ "description": "A Search Ads 360 product ad.",
+ "id": "GoogleAdsSearchads360V0Common__SearchAds360ProductAdInfo",
+ "properties": {},
+ "type": "object"
+ },
+ "GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo": {
+ "description": "A Search Ads 360 responsive search ad.",
+ "id": "GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo",
+ "properties": {
+ "adTrackingId": {
+ "description": "The tracking id of the ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "path1": {
+ "description": "Text appended to the auto-generated visible URL with a delimiter.",
+ "type": "string"
+ },
+ "path2": {
+ "description": "Text appended to path1 with a delimiter.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo": {
+ "description": "A Search Ads 360 text ad.",
+ "id": "GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo",
+ "properties": {
+ "adTrackingId": {
+ "description": "The tracking id of the ad.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description1": {
+ "description": "The first line of the ad's description.",
+ "type": "string"
+ },
+ "description2": {
+ "description": "The second line of the ad's description.",
+ "type": "string"
+ },
+ "displayMobileUrl": {
+ "description": "The displayed mobile URL of the ad.",
+ "type": "string"
+ },
+ "displayUrl": {
+ "description": "The displayed URL of the ad.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "The headline of the ad.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleAdsSearchads360V0Common__Segments": {
"description": "Segment only fields.",
"id": "GoogleAdsSearchads360V0Common__Segments",
@@ -1119,6 +1224,10 @@
],
"type": "string"
},
+ "keyword": {
+ "$ref": "GoogleAdsSearchads360V0Common__Keyword",
+ "description": "Keyword criterion."
+ },
"month": {
"description": "Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.",
"type": "string"
@@ -2255,6 +2364,14 @@
"description": "The URL that appears in the ad description for some ad formats.",
"type": "string"
},
+ "expandedDynamicSearchAd": {
+ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo",
+ "description": "Immutable. Details pertaining to an expanded dynamic search ad."
+ },
+ "expandedTextAd": {
+ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo",
+ "description": "Immutable. Details pertaining to an expanded text ad."
+ },
"finalUrls": {
"description": "The list of possible final URLs after all cross-domain redirects for the ad.",
"items": {
@@ -2272,10 +2389,22 @@
"description": "Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.",
"type": "string"
},
+ "productAd": {
+ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ProductAdInfo",
+ "description": "Immutable. Details pertaining to a product ad."
+ },
"resourceName": {
"description": "Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`",
"type": "string"
},
+ "responsiveSearchAd": {
+ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo",
+ "description": "Immutable. Details pertaining to a responsive search ad."
+ },
+ "textAd": {
+ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo",
+ "description": "Immutable. Details pertaining to a text ad."
+ },
"type": {
"description": "Output only. The type of ad.",
"enum": [
@@ -2822,7 +2951,8 @@
},
"location": {
"$ref": "GoogleAdsSearchads360V0Common__LocationInfo",
- "description": "Immutable. Location."
+ "description": "Output only. Location.",
+ "readOnly": true
},
"negative": {
"description": "Immutable. Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.",
@@ -3442,7 +3572,7 @@
"The asset is linked for use as a Promotion extension.",
"The asset is linked for use as a Callout extension.",
"The asset is linked for use as a Structured Snippet extension.",
- "The asset is linked for use as a Sitelink extension.",
+ "The asset is linked for use as a Sitelink.",
"The asset is linked for use as a Mobile App extension.",
"The asset is linked for use as a Hotel Callout extension.",
"The asset is linked for use as a Call extension.",
@@ -5141,74 +5271,6 @@
}
},
"type": "object"
- },
- "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamRequest": {
- "description": "Request message for SearchAds360Service.SearchStream.",
- "id": "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamRequest",
- "properties": {
- "batchSize": {
- "description": "The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows.",
- "format": "int32",
- "type": "integer"
- },
- "query": {
- "description": "Required. The query string.",
- "type": "string"
- },
- "summaryRowSetting": {
- "description": "Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned.",
- "enum": [
- "UNSPECIFIED",
- "UNKNOWN",
- "NO_SUMMARY_ROW",
- "SUMMARY_ROW_WITH_RESULTS",
- "SUMMARY_ROW_ONLY"
- ],
- "enumDescriptions": [
- "Not specified.",
- "Represent unknown values of return summary row.",
- "Do not return summary row.",
- "Return summary row along with results. The summary row will be returned in the last batch alone (last batch will contain no results).",
- "Return summary row only and return no results."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamResponse": {
- "description": "Response message for SearchAds360Service.SearchStream.",
- "id": "GoogleAdsSearchads360V0Services__SearchSearchAds360StreamResponse",
- "properties": {
- "customColumnHeaders": {
- "description": "The headers of the custom columns in the results.",
- "items": {
- "$ref": "GoogleAdsSearchads360V0Services__CustomColumnHeader"
- },
- "type": "array"
- },
- "fieldMask": {
- "description": "FieldMask that represents what fields were requested by the user.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "requestId": {
- "description": "The unique id of the request that is used for debugging purposes.",
- "type": "string"
- },
- "results": {
- "description": "The list of rows that matched the query.",
- "items": {
- "$ref": "GoogleAdsSearchads360V0Services__SearchAds360Row"
- },
- "type": "array"
- },
- "summaryRow": {
- "$ref": "GoogleAdsSearchads360V0Services__SearchAds360Row",
- "description": "Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc."
- }
- },
- "type": "object"
}
},
"servicePath": "",