Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()

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]()

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.Search.
"pageSize": 42, # Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.
"pageToken": "A String", # Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results.
"query": "A String", # Required. The query string.
"returnTotalResultsCount": True or False, # If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.
"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.
"validateOnly": True or False, # If true, the request is validated but not executed.
}

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.Search.
"conversionCustomDimensionHeaders": [ # The headers of the conversion custom dimensions in the results.
{ # Message for conversion custom dimension header.
"id": "A String", # The conversion custom dimension ID.
"name": "A String", # The user defined name of the conversion custom dimension.
},
],
"conversionCustomMetricHeaders": [ # The headers of the conversion custom metrics in the results.
{ # Message for conversion custom metric header.
"id": "A String", # The conversion custom metric ID.
"name": "A String", # The user defined name of the conversion custom metric.
},
],
"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.
"nextPageToken": "A String", # Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.
"rawEventConversionDimensionHeaders": [ # The headers of the raw event conversion dimensions in the results.
{ # Message for raw event conversion dimension header.
"id": "A String", # The conversion custom variable ID.
"name": "A String", # The user defined name of the raw event dimension.
},
],
"rawEventConversionMetricHeaders": [ # The headers of the raw event conversion metrics in the results.
{ # Message for raw event conversion metric header.
"id": "A String", # The conversion custom variable ID.
"name": "A String", # The user defined name of the raw event metric.
},
],
"results": [ # The list of rows that matched the query.
{ # A returned row from the query.
"accessibleBiddingStrategy": { # Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes. # The accessible bidding strategy referenced in the query.
"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. # Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
"targetRoas": 3.14, # Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
},
"maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
"targetCpa": "A String", # Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
"targetCpaMicros": "A String", # Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
},
"name": "A String", # Output only. The name of the bidding strategy.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the bidding strategy.
"ownerDescriptiveName": "A String", # Output only. descriptive_name of the Customer which owns the bidding strategy.
"resourceName": "A String", # Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`
"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. # Output only. A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
"targetCpaMicros": "A String", # Output only. 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). # Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
"cpcBidCeilingMicros": "A String", # Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
"location": "A String", # Output only. 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). # Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
"targetRoas": 3.14, # Output only. The chosen revenue (based on conversion data) per unit of spend.
},
"targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.
"cpcBidCeilingMicros": "A String", # Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
"targetSpendMicros": "A String", # Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
},
"type": "A String", # Output only. The type of the bidding strategy.
},
"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.
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.
"A String",
],
"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.
"expandedDynamicSearchAd": { # An expanded dynamic search ad. # Immutable. Details pertaining to an expanded dynamic search ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
},
"expandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
"headline": "A String", # The headline of the ad.
"headline2": "A String", # The second headline of the ad.
"headline3": "A String", # The third headline of the ad.
"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter.
"path2": "A String", # Text appended to path1 with a delimiter.
},
"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.
"productAd": { # A Search Ads 360 product ad. # Immutable. Details pertaining to a product ad.
},
"resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
"responsiveSearchAd": { # A Search Ads 360 responsive search ad. # Immutable. Details pertaining to a responsive search ad.
"adTrackingId": "A String", # The tracking id of the ad.
"descriptions": [ # List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
{ # A text asset used inside an ad.
"text": "A String", # Asset text.
},
],
"headlines": [ # List of text assets for headlines. When the ad serves the headlines will be selected from this list.
{ # A text asset used inside an ad.
"text": "A String", # Asset text.
},
],
"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter.
"path2": "A String", # Text appended to path1 with a delimiter.
},
"textAd": { # A Search Ads 360 text ad. # Immutable. Details pertaining to a text ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
"displayMobileUrl": "A String", # The displayed mobile URL of the ad.
"displayUrl": "A String", # The displayed URL of the ad.
"headline": "A String", # The headline of the ad.
},
"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 Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"adGroupAsset": { # A link between an ad group and an asset. # The ad group asset referenced in the query.
"adGroup": "A String", # Required. Immutable. The ad group to which the asset is linked.
"asset": "A String", # Required. Immutable. The asset which is linked to the ad group.
"resourceName": "A String", # Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
"status": "A String", # Status of the ad group asset.
},
"adGroupAssetSet": { # AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group. # The ad group asset set referenced in the query.
"adGroup": "A String", # Immutable. The ad group to which this asset set is linked.
"assetSet": "A String", # Immutable. The asset set which is linked to the ad group.
"resourceName": "A String", # Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
"status": "A String", # Output only. The status of the ad group asset set. Read-only.
},
"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 ad_group_criterion report only returns criteria that were explicitly added to the ad group. # 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.
"positionEstimates": { # Estimates for criterion bids at various positions. # Output only. Estimates for criterion bids at various positions.
"topOfPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
},
"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.
"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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"adGroupEffectiveLabel": { # A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group. # The ad group effective label referenced in the query.
"adGroup": "A String", # Immutable. The ad group to which the effective label is attached.
"label": "A String", # Immutable. The effective label assigned to the ad group.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the effective label.
"resourceName": "A String", # Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"asset": { # Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it. # The asset referenced in the query.
"callAsset": { # A unified call asset. # Output only. A unified call asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"callConversionAction": "A String", # The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
"callConversionReportingState": "A String", # Output only. Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
"callOnly": True or False, # Whether the call only shows the phone number without a link to the website. Applies to Microsoft Ads.
"callTrackingEnabled": True or False, # Whether the call should be enabled on call tracking. Applies to Microsoft Ads.
"countryCode": "A String", # Two-letter country code of the phone number. Examples: 'US', 'us'.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"phoneNumber": "A String", # The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"useSearcherTimeZone": True or False, # Whether to show the call extension in search user's time zone. Applies to Microsoft Ads.
},
"callToActionAsset": { # A call to action asset. # Immutable. A call to action asset.
"callToAction": "A String", # Call to action.
},
"calloutAsset": { # A unified callout asset. # Output only. A unified callout asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"calloutText": "A String", # The callout text. The length of this string should be between 1 and 25, inclusive.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"useSearcherTimeZone": True or False, # Whether to show the asset in search user's time zone. Applies to Microsoft Ads.
},
"creationTime": "A String", # Output only. The timestamp when this asset was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"engineStatus": "A String", # Output only. The Engine Status for an asset.
"finalUrls": [ # A list of possible final URLs after all cross domain redirects.
"A String",
],
"id": "A String", # Output only. The ID of the asset.
"imageAsset": { # An Image asset. # Output only. An image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Metadata for an image at a certain size, either original or resized. # Metadata for this image at its original size.
"heightPixels": "A String", # Height of the image.
"url": "A String", # A URL that returns the image with this height and width.
"widthPixels": "A String", # Width of the image.
},
"mimeType": "A String", # MIME type of the image asset.
},
"lastModifiedTime": "A String", # Output only. The datetime when this asset was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"locationAsset": { # A unified location asset. # Output only. A unified location asset.
"businessProfileLocations": [ # The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
{ # Business Profile location data synced from the linked Business Profile account.
"labels": [ # Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
"A String",
],
"listingId": "A String", # Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
"storeCode": "A String", # Business Profile store code of this location. This is synced from the Business Profile account.
},
],
"locationOwnershipType": "A String", # The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.
"placeId": "A String", # Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
},
"mobileAppAsset": { # An asset representing a mobile app. # A mobile app asset.
"appId": "A String", # Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
"appStore": "A String", # Required. The application store that distributes this specific app.
},
"name": "A String", # Optional name of the asset.
"pageFeedAsset": { # A Unified Page Feed asset. # Output only. A unified page feed asset.
"labels": [ # Labels used to group the page urls.
"A String",
],
"pageUrl": "A String", # The webpage that advertisers want to target.
},
"resourceName": "A String", # Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
"sitelinkAsset": { # A unified sitelink asset. # Output only. A unified sitelink asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"description1": "A String", # First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
"description2": "A String", # Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"linkText": "A String", # URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
"mobilePreferred": True or False, # Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to Microsoft Ads.
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"trackingId": "A String", # ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
"useSearcherTimeZone": True or False, # Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
},
"status": "A String", # Output only. The status of the asset.
"textAsset": { # A Text asset. # Output only. A text asset.
"text": "A String", # Text content of the text asset.
},
"trackingUrlTemplate": "A String", # URL template for constructing a tracking URL.
"type": "A String", # Output only. Type of the asset.
"youtubeVideoAsset": { # A YouTube asset. # Immutable. A YouTube video asset.
"youtubeVideoId": "A String", # YouTube video id. This is the 11 character string value used in the YouTube video URL.
"youtubeVideoTitle": "A String", # YouTube video title.
},
},
"assetGroup": { # An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group. # The asset group referenced in the query.
"adStrength": "A String", # Output only. Overall ad strength of this asset group.
"campaign": "A String", # Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
"finalMobileUrls": [ # A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"finalUrls": [ # A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"id": "A String", # Output only. The ID of the asset group.
"name": "A String", # Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
"path1": "A String", # First part of text that may appear appended to the url displayed in the ad.
"path2": "A String", # Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
"resourceName": "A String", # Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
"status": "A String", # The status of the asset group.
},
"assetGroupAsset": { # AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group. # The asset group asset referenced in the query.
"asset": "A String", # Immutable. The asset which this asset group asset is linking.
"assetGroup": "A String", # Immutable. The asset group which this asset group asset is linking.
"fieldType": "A String", # The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc
"resourceName": "A String", # Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
"status": "A String", # The status of the link between an asset and asset group.
},
"assetGroupListingGroupFilter": { # AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group. # The asset group listing group filter referenced in the query.
"assetGroup": "A String", # Immutable. The asset group which this asset group listing group filter is part of.
"caseValue": { # Listing dimensions for the asset group listing group filter. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"productBiddingCategory": { # One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # Bidding category of a product offer.
"id": "A String", # ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
"level": "A String", # Indicates the level of the category in the taxonomy.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
},
"id": "A String", # Output only. The ID of the ListingGroupFilter.
"parentListingGroupFilter": "A String", # Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
"path": { # The path defining of dimensions defining a listing group filter. # Output only. The path of dimensions defining this listing group filter.
"dimensions": [ # Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
{ # Listing dimensions for the asset group listing group filter.
"productBiddingCategory": { # One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # Bidding category of a product offer.
"id": "A String", # ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
"level": "A String", # Indicates the level of the category in the taxonomy.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
},
],
},
"resourceName": "A String", # Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
"type": "A String", # Immutable. Type of a listing group filter node.
"vertical": "A String", # Immutable. The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical.
},
"assetGroupSignal": { # AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more. # The asset group signal referenced in the query.
"assetGroup": "A String", # Immutable. The asset group which this asset group signal belongs to.
"audience": { # An audience criterion. # Immutable. The audience signal to be used by the performance max campaign.
"audience": "A String", # The Audience resource name.
},
"resourceName": "A String", # Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
},
"assetGroupTopCombinationView": { # A view on the usage of ad group ad asset combination. # The asset group top combination view referenced in the query.
"assetGroupTopCombinations": [ # Output only. The top combinations of assets that served together.
{ # Asset group asset combination data
"assetCombinationServedAssets": [ # Output only. Served assets.
{ # Contains the usage information of the asset.
"asset": "A String", # Resource name of the asset.
"servedAssetFieldType": "A String", # The served field type of the asset.
},
],
},
],
"resourceName": "A String", # Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"
},
"assetSet": { # An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set. # The asset set referenced in the query.
"id": "A String", # Output only. The ID of the asset set.
"resourceName": "A String", # Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`
},
"assetSetAsset": { # AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set. # The asset set asset referenced in the query.
"asset": "A String", # Immutable. The asset which this asset set asset is linking to.
"assetSet": "A String", # Immutable. The asset set which this asset set asset is linking to.
"resourceName": "A String", # Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
"status": "A String", # Output only. The status of the asset set asset. Read-only.
},
"audience": { # Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments. # The Audience referenced in the query.
"description": "A String", # Description of this audience.
"id": "A String", # Output only. ID of the audience.
"name": "A String", # Required. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.
"resourceName": "A String", # Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_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", # Deprecated: 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.
"accessibleBiddingStrategy": "A String", # Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
"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", # The resource name of the portfolio bidding strategy used by the 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 resource name of the campaign 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.
},
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
"A String",
],
"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. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType. # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
"conversionActions": [ # The selected set of resource names for 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", # Deprecated: 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.
},
"campaignAsset": { # A link between a Campaign and an Asset. # The campaign asset referenced in the query.
"asset": "A String", # Immutable. The asset which is linked to the campaign.
"campaign": "A String", # Immutable. The campaign to which the asset is linked.
"resourceName": "A String", # Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
"status": "A String", # Output only. Status of the campaign asset.
},
"campaignAssetSet": { # CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign. # The campaign asset set referenced in the query.
"assetSet": "A String", # Immutable. The asset set which is linked to the campaign.
"campaign": "A String", # Immutable. The campaign to which this asset set is linked.
"resourceName": "A String", # Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
"status": "A String", # Output only. The status of the campaign asset set asset. Read-only.
},
"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.
"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.
},
},
"campaignEffectiveLabel": { # Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign. # The campaign effective label referenced in the query.
"campaign": "A String", # Immutable. The campaign to which the effective label is attached.
"label": "A String", # Immutable. The effective label assigned to the campaign.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the effective label.
"resourceName": "A String", # Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`
},
"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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
},
"cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query.
"resourceName": "A String", # Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView`
},
"conversion": { # A conversion. # The event level conversion referenced in the query.
"adId": "A String", # Output only. Ad ID. A value of 0 indicates that the ad is unattributed.
"advertiserConversionId": "A String", # Output only. For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.
"assetFieldType": "A String", # Output only. Asset field type of the conversion event.
"assetId": "A String", # Output only. ID of the asset which was interacted with during the conversion event.
"attributionType": "A String", # Output only. What the conversion is attributed to: Visit or Keyword+Ad.
"clickId": "A String", # Output only. A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.
"conversionDateTime": "A String", # Output only. The timestamp of the conversion event.
"conversionLastModifiedDateTime": "A String", # Output only. The timestamp of the last time the conversion was modified.
"conversionQuantity": "A String", # Output only. The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.
"conversionRevenueMicros": "A String", # Output only. The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.
"conversionVisitDateTime": "A String", # Output only. The timestamp of the visit that the conversion is attributed to.
"criterionId": "A String", # Output only. Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.
"floodlightOrderId": "A String", # Output only. The Floodlight order ID provided by the advertiser for the conversion.
"floodlightOriginalRevenue": "A String", # Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.
"id": "A String", # Output only. The ID of the conversion
"merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.
"productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local.
"productCountryCode": "A String", # Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.
"productId": "A String", # Output only. The ID of the product clicked on.
"productLanguageCode": "A String", # Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.
"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.
"resourceName": "A String", # Output only. The resource name of the conversion. Conversion resource names have the form: `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}`
"status": "A String", # Output only. The status of the conversion, either ENABLED or REMOVED..
"visitId": "A String", # Output only. The Search Ads 360 visit ID that the conversion is attributed to.
},
"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.
},
},
"conversionCustomVariable": { # A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857 # The conversion custom variable referenced in the query.
"cardinality": "A String", # Output only. Cardinality of the conversion custom variable.
"customColumnIds": [ # Output only. The IDs of custom columns that use this conversion custom variable.
"A String",
],
"family": "A String", # Output only. Family of the conversion custom variable.
"floodlightConversionCustomVariableInfo": { # Information for Search Ads 360 Floodlight Conversion Custom Variables. # Output only. Fields for Search Ads 360 floodlight conversion custom variables.
"floodlightVariableDataType": "A String", # Output only. Floodlight variable data type defined in Search Ads 360.
"floodlightVariableType": "A String", # Output only. Floodlight variable type defined in Search Ads 360.
},
"id": "A String", # Output only. The ID of the conversion custom variable.
"name": "A String", # Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
"ownerCustomer": "A String", # Output only. The resource name of the customer that owns the conversion custom variable.
"resourceName": "A String", # Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
"status": "A String", # The status of the conversion custom variable for conversion event accrual.
"tag": "A String", # Required. Immutable. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".
},
"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.
},
"customerAsset": { # A link between a customer and an asset. # The customer asset referenced in the query.
"asset": "A String", # Required. Immutable. The asset which is linked to the customer.
"resourceName": "A String", # Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
"status": "A String", # Status of the customer asset.
},
"customerAssetSet": { # CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer. # The customer asset set referenced in the query.
"assetSet": "A String", # Immutable. The asset set which is linked to the customer.
"customer": "A String", # Immutable. The customer to which this asset set is linked.
"resourceName": "A String", # Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: `customers/{customer_id}/customerAssetSets/{asset_set_id}`
"status": "A String", # Output only. The status of the customer asset set asset. Read-only.
},
"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}`
"startTime": "A String", # Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"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 resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # 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}`
},
"geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query.
"canonicalName": "A String", # Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
"countryCode": "A String", # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
"id": "A String", # Output only. The ID of the geo target constant.
"name": "A String", # Output only. Geo target constant English name.
"parentGeoTarget": "A String", # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
"resourceName": "A String", # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
"status": "A String", # Output only. Geo target constant status.
"targetType": "A String", # Output only. Geo target constant target type.
},
"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 HEX 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.
},
},
"languageConstant": { # A language. # The language constant referenced in the query.
"code": "A String", # Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc.
"id": "A String", # Output only. The ID of the language constant.
"name": "A String", # Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc.
"resourceName": "A String", # Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
"targetable": True or False, # Output only. Whether the language is targetable.
},
"locationView": { # A location view summarizes the performance of campaigns by a Location criterion. # 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, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
"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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"averageQualityScore": 3.14, # The average quality score.
"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.
"clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
"clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
"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.
"conversionCustomMetrics": [ # The conversion custom metrics.
{ # 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.
},
],
"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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"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.
"crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
"crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions.
"crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
"crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
"ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
"generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
"generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
"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.
"leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
"mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page.
"rawEventConversionMetrics": [ # The raw event conversion metrics.
{ # 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.
},
],
"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 among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"searchTopImpressionShare": 3.14, # The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries.
"topImpressionPercentage": 3.14, # The percent of your ad impressions that are shown adjacent to the top 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.
},
"productBiddingCategoryConstant": { # A Product Bidding Category. # The Product Bidding Category referenced in the query.
"countryCode": "A String", # Output only. Two-letter upper-case country code of the product bidding category.
"id": "A String", # Output only. ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
"languageCode": "A String", # Output only. Language code of the product bidding category.
"level": "A String", # Output only. Level of the product bidding category.
"localizedName": "A String", # Output only. Display value of the product bidding category localized according to language_code.
"productBiddingCategoryConstantParent": "A String", # Output only. Resource name of the parent product bidding category.
"resourceName": "A String", # Output only. The resource name of the product bidding category. Product bidding category resource names have the form: `productBiddingCategoryConstants/{country_code}~{level}~{id}`
"status": "A String", # Output only. Status of the product bidding category.
},
"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.
"adNetworkType": "A String", # Ad network type.
"assetInteractionTarget": { # An AssetInteractionTarget segment. # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with.
"asset": "A String", # The asset resource name.
"interactionOnThisAsset": True or False, # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
},
"conversionAction": "A String", # Resource name of the conversion action.
"conversionActionCategory": "A String", # Conversion action category.
"conversionActionName": "A String", # Conversion action name.
"conversionCustomDimensions": [ # The conversion custom dimensions.
{ # 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.
},
],
"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.
"geoTargetCity": "A String", # Resource name of the geo target constant that represents a city.
"geoTargetCountry": "A String", # Resource name of the geo target constant that represents a country.
"geoTargetMetro": "A String", # Resource name of the geo target constant that represents a metro.
"geoTargetRegion": "A String", # Resource name of the geo target constant that represents a region.
"hour": 42, # Hour of day as a number between 0 and 23, inclusive.
"keyword": { # A Keyword criterion segment. # Keyword criterion.
"adGroupCriterion": "A String", # The AdGroupCriterion resource name.
"info": { # A keyword criterion. # Keyword info.
"matchType": "A String", # The match type of the keyword.
"text": "A String", # The text of the keyword (at most 80 characters and 10 words).
},
},
"month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
"productBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product.
"productBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product.
"productBiddingCategoryLevel3": "A String", # Bidding category (level 3) of the product.
"productBiddingCategoryLevel4": "A String", # Bidding category (level 4) of the product.
"productBiddingCategoryLevel5": "A String", # Bidding category (level 5) of the product.
"productBrand": "A String", # Brand of the product.
"productChannel": "A String", # Channel of the product.
"productChannelExclusivity": "A String", # Channel exclusivity of the product.
"productCondition": "A String", # Condition of the product.
"productCountry": "A String", # Resource name of the geo target constant for the country of sale of the product.
"productCustomAttribute0": "A String", # Custom attribute 0 of the product.
"productCustomAttribute1": "A String", # Custom attribute 1 of the product.
"productCustomAttribute2": "A String", # Custom attribute 2 of the product.
"productCustomAttribute3": "A String", # Custom attribute 3 of the product.
"productCustomAttribute4": "A String", # Custom attribute 4 of the product.
"productItemId": "A String", # Item ID of the product.
"productLanguage": "A String", # Resource name of the language constant for the language of the product.
"productSoldBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product sold.
"productSoldBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product sold.
"productSoldBiddingCategoryLevel3": "A String", # Bidding category (level 3) of the product sold.
"productSoldBiddingCategoryLevel4": "A String", # Bidding category (level 4) of the product sold.
"productSoldBiddingCategoryLevel5": "A String", # Bidding category (level 5) of the product sold.
"productSoldBrand": "A String", # Brand of the product sold.
"productSoldCondition": "A String", # Condition of the product sold.
"productSoldCustomAttribute0": "A String", # Custom attribute 0 of the product sold.
"productSoldCustomAttribute1": "A String", # Custom attribute 1 of the product sold.
"productSoldCustomAttribute2": "A String", # Custom attribute 2 of the product sold.
"productSoldCustomAttribute3": "A String", # Custom attribute 3 of the product sold.
"productSoldCustomAttribute4": "A String", # Custom attribute 4 of the product sold.
"productSoldItemId": "A String", # Item ID of the product sold.
"productSoldTitle": "A String", # Title of the product sold.
"productSoldTypeL1": "A String", # Type (level 1) of the product sold.
"productSoldTypeL2": "A String", # Type (level 2) of the product sold.
"productSoldTypeL3": "A String", # Type (level 3) of the product sold.
"productSoldTypeL4": "A String", # Type (level 4) of the product sold.
"productSoldTypeL5": "A String", # Type (level 5) of the product sold.
"productStoreId": "A String", # Store ID of the product.
"productTitle": "A String", # Title of the product.
"productTypeL1": "A String", # Type (level 1) of the product.
"productTypeL2": "A String", # Type (level 2) of the product.
"productTypeL3": "A String", # Type (level 3) of the product.
"productTypeL4": "A String", # Type (level 4) of the product.
"productTypeL5": "A String", # Type (level 5) of the product.
"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.
"rawEventConversionDimensions": [ # The raw event conversion dimensions.
{ # 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.
},
],
"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.
},
"shoppingPerformanceView": { # Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded. # The shopping performance view referenced in the query.
"resourceName": "A String", # Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
},
"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.
},
"visit": { # A visit. # The event level visit referenced in the query.
"adId": "A String", # Output only. Ad ID. A value of 0 indicates that the ad is unattributed.
"assetFieldType": "A String", # Output only. Asset field type of the visit event.
"assetId": "A String", # Output only. ID of the asset which was interacted with during the visit event.
"clickId": "A String", # Output only. A unique string for each visit that is passed to the landing page as the click id URL parameter.
"criterionId": "A String", # Output only. Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.
"id": "A String", # Output only. The ID of the visit.
"merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.
"productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local.
"productCountryCode": "A String", # Output only. The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.
"productId": "A String", # Output only. The ID of the product clicked on.
"productLanguageCode": "A String", # Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.
"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.
"resourceName": "A String", # Output only. The resource name of the visit. Visit resource names have the form: `customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}`
"visitDateTime": "A String", # Output only. The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
},
"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.
"accessibleBiddingStrategy": { # Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes. # The accessible bidding strategy referenced in the query.
"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. # Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
"targetRoas": 3.14, # Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
},
"maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
"targetCpa": "A String", # Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
"targetCpaMicros": "A String", # Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
},
"name": "A String", # Output only. The name of the bidding strategy.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the bidding strategy.
"ownerDescriptiveName": "A String", # Output only. descriptive_name of the Customer which owns the bidding strategy.
"resourceName": "A String", # Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`
"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. # Output only. A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
"targetCpaMicros": "A String", # Output only. 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). # Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
"cpcBidCeilingMicros": "A String", # Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
"location": "A String", # Output only. 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). # Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
"targetRoas": 3.14, # Output only. The chosen revenue (based on conversion data) per unit of spend.
},
"targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.
"cpcBidCeilingMicros": "A String", # Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
"targetSpendMicros": "A String", # Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
},
"type": "A String", # Output only. The type of the bidding strategy.
},
"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.
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.
"A String",
],
"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.
"expandedDynamicSearchAd": { # An expanded dynamic search ad. # Immutable. Details pertaining to an expanded dynamic search ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
},
"expandedTextAd": { # A Search Ads 360 expanded text ad. # Immutable. Details pertaining to an expanded text ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
"headline": "A String", # The headline of the ad.
"headline2": "A String", # The second headline of the ad.
"headline3": "A String", # The third headline of the ad.
"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter.
"path2": "A String", # Text appended to path1 with a delimiter.
},
"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.
"productAd": { # A Search Ads 360 product ad. # Immutable. Details pertaining to a product ad.
},
"resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
"responsiveSearchAd": { # A Search Ads 360 responsive search ad. # Immutable. Details pertaining to a responsive search ad.
"adTrackingId": "A String", # The tracking id of the ad.
"descriptions": [ # List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
{ # A text asset used inside an ad.
"text": "A String", # Asset text.
},
],
"headlines": [ # List of text assets for headlines. When the ad serves the headlines will be selected from this list.
{ # A text asset used inside an ad.
"text": "A String", # Asset text.
},
],
"path1": "A String", # Text appended to the auto-generated visible URL with a delimiter.
"path2": "A String", # Text appended to path1 with a delimiter.
},
"textAd": { # A Search Ads 360 text ad. # Immutable. Details pertaining to a text ad.
"adTrackingId": "A String", # The tracking id of the ad.
"description1": "A String", # The first line of the ad's description.
"description2": "A String", # The second line of the ad's description.
"displayMobileUrl": "A String", # The displayed mobile URL of the ad.
"displayUrl": "A String", # The displayed URL of the ad.
"headline": "A String", # The headline of the ad.
},
"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 Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"adGroupAsset": { # A link between an ad group and an asset. # The ad group asset referenced in the query.
"adGroup": "A String", # Required. Immutable. The ad group to which the asset is linked.
"asset": "A String", # Required. Immutable. The asset which is linked to the ad group.
"resourceName": "A String", # Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
"status": "A String", # Status of the ad group asset.
},
"adGroupAssetSet": { # AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group. # The ad group asset set referenced in the query.
"adGroup": "A String", # Immutable. The ad group to which this asset set is linked.
"assetSet": "A String", # Immutable. The asset set which is linked to the ad group.
"resourceName": "A String", # Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
"status": "A String", # Output only. The status of the ad group asset set. Read-only.
},
"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 ad_group_criterion report only returns criteria that were explicitly added to the ad group. # 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.
"positionEstimates": { # Estimates for criterion bids at various positions. # Output only. Estimates for criterion bids at various positions.
"topOfPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
},
"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.
"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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"adGroupEffectiveLabel": { # A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group. # The ad group effective label referenced in the query.
"adGroup": "A String", # Immutable. The ad group to which the effective label is attached.
"label": "A String", # Immutable. The effective label assigned to the ad group.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the effective label.
"resourceName": "A String", # Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"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}`
},
"asset": { # Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it. # The asset referenced in the query.
"callAsset": { # A unified call asset. # Output only. A unified call asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"callConversionAction": "A String", # The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
"callConversionReportingState": "A String", # Output only. Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
"callOnly": True or False, # Whether the call only shows the phone number without a link to the website. Applies to Microsoft Ads.
"callTrackingEnabled": True or False, # Whether the call should be enabled on call tracking. Applies to Microsoft Ads.
"countryCode": "A String", # Two-letter country code of the phone number. Examples: 'US', 'us'.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"phoneNumber": "A String", # The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"useSearcherTimeZone": True or False, # Whether to show the call extension in search user's time zone. Applies to Microsoft Ads.
},
"callToActionAsset": { # A call to action asset. # Immutable. A call to action asset.
"callToAction": "A String", # Call to action.
},
"calloutAsset": { # A unified callout asset. # Output only. A unified callout asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"calloutText": "A String", # The callout text. The length of this string should be between 1 and 25, inclusive.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"useSearcherTimeZone": True or False, # Whether to show the asset in search user's time zone. Applies to Microsoft Ads.
},
"creationTime": "A String", # Output only. The timestamp when this asset was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"engineStatus": "A String", # Output only. The Engine Status for an asset.
"finalUrls": [ # A list of possible final URLs after all cross domain redirects.
"A String",
],
"id": "A String", # Output only. The ID of the asset.
"imageAsset": { # An Image asset. # Output only. An image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Metadata for an image at a certain size, either original or resized. # Metadata for this image at its original size.
"heightPixels": "A String", # Height of the image.
"url": "A String", # A URL that returns the image with this height and width.
"widthPixels": "A String", # Width of the image.
},
"mimeType": "A String", # MIME type of the image asset.
},
"lastModifiedTime": "A String", # Output only. The datetime when this asset was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"locationAsset": { # A unified location asset. # Output only. A unified location asset.
"businessProfileLocations": [ # The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
{ # Business Profile location data synced from the linked Business Profile account.
"labels": [ # Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
"A String",
],
"listingId": "A String", # Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
"storeCode": "A String", # Business Profile store code of this location. This is synced from the Business Profile account.
},
],
"locationOwnershipType": "A String", # The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.
"placeId": "A String", # Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
},
"mobileAppAsset": { # An asset representing a mobile app. # A mobile app asset.
"appId": "A String", # Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
"appStore": "A String", # Required. The application store that distributes this specific app.
},
"name": "A String", # Optional name of the asset.
"pageFeedAsset": { # A Unified Page Feed asset. # Output only. A unified page feed asset.
"labels": [ # Labels used to group the page urls.
"A String",
],
"pageUrl": "A String", # The webpage that advertisers want to target.
},
"resourceName": "A String", # Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
"sitelinkAsset": { # A unified sitelink asset. # Output only. A unified sitelink asset.
"adScheduleTargets": [ # List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
{ # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
],
"description1": "A String", # First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
"description2": "A String", # Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
"endDate": "A String", # Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
"linkText": "A String", # URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
"mobilePreferred": True or False, # Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to Microsoft Ads.
"startDate": "A String", # Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
"trackingId": "A String", # ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
"useSearcherTimeZone": True or False, # Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
},
"status": "A String", # Output only. The status of the asset.
"textAsset": { # A Text asset. # Output only. A text asset.
"text": "A String", # Text content of the text asset.
},
"trackingUrlTemplate": "A String", # URL template for constructing a tracking URL.
"type": "A String", # Output only. Type of the asset.
"youtubeVideoAsset": { # A YouTube asset. # Immutable. A YouTube video asset.
"youtubeVideoId": "A String", # YouTube video id. This is the 11 character string value used in the YouTube video URL.
"youtubeVideoTitle": "A String", # YouTube video title.
},
},
"assetGroup": { # An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group. # The asset group referenced in the query.
"adStrength": "A String", # Output only. Overall ad strength of this asset group.
"campaign": "A String", # Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
"finalMobileUrls": [ # A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"finalUrls": [ # A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"id": "A String", # Output only. The ID of the asset group.
"name": "A String", # Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
"path1": "A String", # First part of text that may appear appended to the url displayed in the ad.
"path2": "A String", # Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
"resourceName": "A String", # Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
"status": "A String", # The status of the asset group.
},
"assetGroupAsset": { # AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group. # The asset group asset referenced in the query.
"asset": "A String", # Immutable. The asset which this asset group asset is linking.
"assetGroup": "A String", # Immutable. The asset group which this asset group asset is linking.
"fieldType": "A String", # The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc
"resourceName": "A String", # Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
"status": "A String", # The status of the link between an asset and asset group.
},
"assetGroupListingGroupFilter": { # AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group. # The asset group listing group filter referenced in the query.
"assetGroup": "A String", # Immutable. The asset group which this asset group listing group filter is part of.
"caseValue": { # Listing dimensions for the asset group listing group filter. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"productBiddingCategory": { # One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # Bidding category of a product offer.
"id": "A String", # ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
"level": "A String", # Indicates the level of the category in the taxonomy.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
},
"id": "A String", # Output only. The ID of the ListingGroupFilter.
"parentListingGroupFilter": "A String", # Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
"path": { # The path defining of dimensions defining a listing group filter. # Output only. The path of dimensions defining this listing group filter.
"dimensions": [ # Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
{ # Listing dimensions for the asset group listing group filter.
"productBiddingCategory": { # One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # Bidding category of a product offer.
"id": "A String", # ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
"level": "A String", # Indicates the level of the category in the taxonomy.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
},
],
},
"resourceName": "A String", # Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
"type": "A String", # Immutable. Type of a listing group filter node.
"vertical": "A String", # Immutable. The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical.
},
"assetGroupSignal": { # AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more. # The asset group signal referenced in the query.
"assetGroup": "A String", # Immutable. The asset group which this asset group signal belongs to.
"audience": { # An audience criterion. # Immutable. The audience signal to be used by the performance max campaign.
"audience": "A String", # The Audience resource name.
},
"resourceName": "A String", # Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
},
"assetGroupTopCombinationView": { # A view on the usage of ad group ad asset combination. # The asset group top combination view referenced in the query.
"assetGroupTopCombinations": [ # Output only. The top combinations of assets that served together.
{ # Asset group asset combination data
"assetCombinationServedAssets": [ # Output only. Served assets.
{ # Contains the usage information of the asset.
"asset": "A String", # Resource name of the asset.
"servedAssetFieldType": "A String", # The served field type of the asset.
},
],
},
],
"resourceName": "A String", # Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"
},
"assetSet": { # An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set. # The asset set referenced in the query.
"id": "A String", # Output only. The ID of the asset set.
"resourceName": "A String", # Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`
},
"assetSetAsset": { # AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set. # The asset set asset referenced in the query.
"asset": "A String", # Immutable. The asset which this asset set asset is linking to.
"assetSet": "A String", # Immutable. The asset set which this asset set asset is linking to.
"resourceName": "A String", # Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
"status": "A String", # Output only. The status of the asset set asset. Read-only.
},
"audience": { # Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments. # The Audience referenced in the query.
"description": "A String", # Description of this audience.
"id": "A String", # Output only. ID of the audience.
"name": "A String", # Required. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.
"resourceName": "A String", # Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_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", # Deprecated: 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.
"accessibleBiddingStrategy": "A String", # Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
"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", # The resource name of the portfolio bidding strategy used by the 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 resource name of the campaign 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.
},
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
"A String",
],
"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. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType. # Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
"conversionActions": [ # The selected set of resource names for 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", # Deprecated: 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.
},
"campaignAsset": { # A link between a Campaign and an Asset. # The campaign asset referenced in the query.
"asset": "A String", # Immutable. The asset which is linked to the campaign.
"campaign": "A String", # Immutable. The campaign to which the asset is linked.
"resourceName": "A String", # Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
"status": "A String", # Output only. Status of the campaign asset.
},
"campaignAssetSet": { # CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign. # The campaign asset set referenced in the query.
"assetSet": "A String", # Immutable. The asset set which is linked to the campaign.
"campaign": "A String", # Immutable. The campaign to which this asset set is linked.
"resourceName": "A String", # Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
"status": "A String", # Output only. The status of the campaign asset set asset. Read-only.
},
"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.
"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.
},
},
"campaignEffectiveLabel": { # Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign. # The campaign effective label referenced in the query.
"campaign": "A String", # Immutable. The campaign to which the effective label is attached.
"label": "A String", # Immutable. The effective label assigned to the campaign.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the effective label.
"resourceName": "A String", # Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`
},
"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.
"ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
"resourceName": "A String", # Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
},
"cartDataSalesView": { # Cart data sales view. # The cart data sales view referenced in the query.
"resourceName": "A String", # Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView`
},
"conversion": { # A conversion. # The event level conversion referenced in the query.
"adId": "A String", # Output only. Ad ID. A value of 0 indicates that the ad is unattributed.
"advertiserConversionId": "A String", # Output only. For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.
"assetFieldType": "A String", # Output only. Asset field type of the conversion event.
"assetId": "A String", # Output only. ID of the asset which was interacted with during the conversion event.
"attributionType": "A String", # Output only. What the conversion is attributed to: Visit or Keyword+Ad.
"clickId": "A String", # Output only. A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.
"conversionDateTime": "A String", # Output only. The timestamp of the conversion event.
"conversionLastModifiedDateTime": "A String", # Output only. The timestamp of the last time the conversion was modified.
"conversionQuantity": "A String", # Output only. The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.
"conversionRevenueMicros": "A String", # Output only. The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.
"conversionVisitDateTime": "A String", # Output only. The timestamp of the visit that the conversion is attributed to.
"criterionId": "A String", # Output only. Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.
"floodlightOrderId": "A String", # Output only. The Floodlight order ID provided by the advertiser for the conversion.
"floodlightOriginalRevenue": "A String", # Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.
"id": "A String", # Output only. The ID of the conversion
"merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.
"productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local.
"productCountryCode": "A String", # Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.
"productId": "A String", # Output only. The ID of the product clicked on.
"productLanguageCode": "A String", # Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.
"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.
"resourceName": "A String", # Output only. The resource name of the conversion. Conversion resource names have the form: `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}`
"status": "A String", # Output only. The status of the conversion, either ENABLED or REMOVED..
"visitId": "A String", # Output only. The Search Ads 360 visit ID that the conversion is attributed to.
},
"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.
},
},
"conversionCustomVariable": { # A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857 # The conversion custom variable referenced in the query.
"cardinality": "A String", # Output only. Cardinality of the conversion custom variable.
"customColumnIds": [ # Output only. The IDs of custom columns that use this conversion custom variable.
"A String",
],
"family": "A String", # Output only. Family of the conversion custom variable.
"floodlightConversionCustomVariableInfo": { # Information for Search Ads 360 Floodlight Conversion Custom Variables. # Output only. Fields for Search Ads 360 floodlight conversion custom variables.
"floodlightVariableDataType": "A String", # Output only. Floodlight variable data type defined in Search Ads 360.
"floodlightVariableType": "A String", # Output only. Floodlight variable type defined in Search Ads 360.
},
"id": "A String", # Output only. The ID of the conversion custom variable.
"name": "A String", # Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
"ownerCustomer": "A String", # Output only. The resource name of the customer that owns the conversion custom variable.
"resourceName": "A String", # Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
"status": "A String", # The status of the conversion custom variable for conversion event accrual.
"tag": "A String", # Required. Immutable. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".
},
"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.
},
"customerAsset": { # A link between a customer and an asset. # The customer asset referenced in the query.
"asset": "A String", # Required. Immutable. The asset which is linked to the customer.
"resourceName": "A String", # Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
"status": "A String", # Status of the customer asset.
},
"customerAssetSet": { # CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer. # The customer asset set referenced in the query.
"assetSet": "A String", # Immutable. The asset set which is linked to the customer.
"customer": "A String", # Immutable. The customer to which this asset set is linked.
"resourceName": "A String", # Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: `customers/{customer_id}/customerAssetSets/{asset_set_id}`
"status": "A String", # Output only. The status of the customer asset set asset. Read-only.
},
"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}`
"startTime": "A String", # Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"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 resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats. # 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}`
},
"geoTargetConstant": { # A geo target constant. # The geo target constant referenced in the query.
"canonicalName": "A String", # Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
"countryCode": "A String", # Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
"id": "A String", # Output only. The ID of the geo target constant.
"name": "A String", # Output only. Geo target constant English name.
"parentGeoTarget": "A String", # Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
"resourceName": "A String", # Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
"status": "A String", # Output only. Geo target constant status.
"targetType": "A String", # Output only. Geo target constant target type.
},
"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 HEX 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.
},
},
"languageConstant": { # A language. # The language constant referenced in the query.
"code": "A String", # Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc.
"id": "A String", # Output only. The ID of the language constant.
"name": "A String", # Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc.
"resourceName": "A String", # Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
"targetable": True or False, # Output only. Whether the language is targetable.
},
"locationView": { # A location view summarizes the performance of campaigns by a Location criterion. # 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, # Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
"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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"averageQualityScore": 3.14, # The average quality score.
"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.
"clientAccountCrossSellCostOfGoodsSoldMicros": "A String", # Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellGrossProfitMicros": "A String", # Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellRevenueMicros": "A String", # Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountCrossSellUnitsSold": 3.14, # Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
"clientAccountLeadCostOfGoodsSoldMicros": "A String", # Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadGrossProfitMicros": "A String", # Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadRevenueMicros": "A String", # Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"clientAccountLeadUnitsSold": 3.14, # Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
"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.
"conversionCustomMetrics": [ # The conversion custom metrics.
{ # 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.
},
],
"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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"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.
"crossDeviceConversionsByConversionDate": 3.14, # The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
"crossDeviceConversionsValue": 3.14, # The sum of the value of cross-device conversions.
"crossDeviceConversionsValueByConversionDate": 3.14, # The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
"crossSellCostOfGoodsSoldMicros": "A String", # Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellGrossProfitMicros": "A String", # Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellRevenueMicros": "A String", # Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"crossSellUnitsSold": 3.14, # Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
"ctr": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
"generalInvalidClickRate": 3.14, # The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
"generalInvalidClicks": "A String", # Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
"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.
"leadCostOfGoodsSoldMicros": "A String", # Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadGrossProfitMicros": "A String", # Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadRevenueMicros": "A String", # Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
"leadUnitsSold": 3.14, # Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
"mobileFriendlyClicksPercentage": 3.14, # The percentage of mobile clicks that go to a mobile-friendly page.
"rawEventConversionMetrics": [ # The raw event conversion metrics.
{ # 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.
},
],
"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 among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"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 adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
"searchTopImpressionShare": 3.14, # The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries.
"topImpressionPercentage": 3.14, # The percent of your ad impressions that are shown adjacent to the top 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.
},
"productBiddingCategoryConstant": { # A Product Bidding Category. # The Product Bidding Category referenced in the query.
"countryCode": "A String", # Output only. Two-letter upper-case country code of the product bidding category.
"id": "A String", # Output only. ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
"languageCode": "A String", # Output only. Language code of the product bidding category.
"level": "A String", # Output only. Level of the product bidding category.
"localizedName": "A String", # Output only. Display value of the product bidding category localized according to language_code.
"productBiddingCategoryConstantParent": "A String", # Output only. Resource name of the parent product bidding category.
"resourceName": "A String", # Output only. The resource name of the product bidding category. Product bidding category resource names have the form: `productBiddingCategoryConstants/{country_code}~{level}~{id}`
"status": "A String", # Output only. Status of the product bidding category.
},
"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.
"adNetworkType": "A String", # Ad network type.
"assetInteractionTarget": { # An AssetInteractionTarget segment. # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with.
"asset": "A String", # The asset resource name.
"interactionOnThisAsset": True or False, # Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
},
"conversionAction": "A String", # Resource name of the conversion action.
"conversionActionCategory": "A String", # Conversion action category.
"conversionActionName": "A String", # Conversion action name.
"conversionCustomDimensions": [ # The conversion custom dimensions.
{ # 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.
},
],
"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.
"geoTargetCity": "A String", # Resource name of the geo target constant that represents a city.
"geoTargetCountry": "A String", # Resource name of the geo target constant that represents a country.
"geoTargetMetro": "A String", # Resource name of the geo target constant that represents a metro.
"geoTargetRegion": "A String", # Resource name of the geo target constant that represents a region.
"hour": 42, # Hour of day as a number between 0 and 23, inclusive.
"keyword": { # A Keyword criterion segment. # Keyword criterion.
"adGroupCriterion": "A String", # The AdGroupCriterion resource name.
"info": { # A keyword criterion. # Keyword info.
"matchType": "A String", # The match type of the keyword.
"text": "A String", # The text of the keyword (at most 80 characters and 10 words).
},
},
"month": "A String", # Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
"productBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product.
"productBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product.
"productBiddingCategoryLevel3": "A String", # Bidding category (level 3) of the product.
"productBiddingCategoryLevel4": "A String", # Bidding category (level 4) of the product.
"productBiddingCategoryLevel5": "A String", # Bidding category (level 5) of the product.
"productBrand": "A String", # Brand of the product.
"productChannel": "A String", # Channel of the product.
"productChannelExclusivity": "A String", # Channel exclusivity of the product.
"productCondition": "A String", # Condition of the product.
"productCountry": "A String", # Resource name of the geo target constant for the country of sale of the product.
"productCustomAttribute0": "A String", # Custom attribute 0 of the product.
"productCustomAttribute1": "A String", # Custom attribute 1 of the product.
"productCustomAttribute2": "A String", # Custom attribute 2 of the product.
"productCustomAttribute3": "A String", # Custom attribute 3 of the product.
"productCustomAttribute4": "A String", # Custom attribute 4 of the product.
"productItemId": "A String", # Item ID of the product.
"productLanguage": "A String", # Resource name of the language constant for the language of the product.
"productSoldBiddingCategoryLevel1": "A String", # Bidding category (level 1) of the product sold.
"productSoldBiddingCategoryLevel2": "A String", # Bidding category (level 2) of the product sold.
"productSoldBiddingCategoryLevel3": "A String", # Bidding category (level 3) of the product sold.
"productSoldBiddingCategoryLevel4": "A String", # Bidding category (level 4) of the product sold.
"productSoldBiddingCategoryLevel5": "A String", # Bidding category (level 5) of the product sold.
"productSoldBrand": "A String", # Brand of the product sold.
"productSoldCondition": "A String", # Condition of the product sold.
"productSoldCustomAttribute0": "A String", # Custom attribute 0 of the product sold.
"productSoldCustomAttribute1": "A String", # Custom attribute 1 of the product sold.
"productSoldCustomAttribute2": "A String", # Custom attribute 2 of the product sold.
"productSoldCustomAttribute3": "A String", # Custom attribute 3 of the product sold.
"productSoldCustomAttribute4": "A String", # Custom attribute 4 of the product sold.
"productSoldItemId": "A String", # Item ID of the product sold.
"productSoldTitle": "A String", # Title of the product sold.
"productSoldTypeL1": "A String", # Type (level 1) of the product sold.
"productSoldTypeL2": "A String", # Type (level 2) of the product sold.
"productSoldTypeL3": "A String", # Type (level 3) of the product sold.
"productSoldTypeL4": "A String", # Type (level 4) of the product sold.
"productSoldTypeL5": "A String", # Type (level 5) of the product sold.
"productStoreId": "A String", # Store ID of the product.
"productTitle": "A String", # Title of the product.
"productTypeL1": "A String", # Type (level 1) of the product.
"productTypeL2": "A String", # Type (level 2) of the product.
"productTypeL3": "A String", # Type (level 3) of the product.
"productTypeL4": "A String", # Type (level 4) of the product.
"productTypeL5": "A String", # Type (level 5) of the product.
"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.
"rawEventConversionDimensions": [ # The raw event conversion dimensions.
{ # 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.
},
],
"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.
},
"shoppingPerformanceView": { # Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded. # The shopping performance view referenced in the query.
"resourceName": "A String", # Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
},
"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.
},
"visit": { # A visit. # The event level visit referenced in the query.
"adId": "A String", # Output only. Ad ID. A value of 0 indicates that the ad is unattributed.
"assetFieldType": "A String", # Output only. Asset field type of the visit event.
"assetId": "A String", # Output only. ID of the asset which was interacted with during the visit event.
"clickId": "A String", # Output only. A unique string for each visit that is passed to the landing page as the click id URL parameter.
"criterionId": "A String", # Output only. Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.
"id": "A String", # Output only. The ID of the visit.
"merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.
"productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local.
"productCountryCode": "A String", # Output only. The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.
"productId": "A String", # Output only. The ID of the product clicked on.
"productLanguageCode": "A String", # Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.
"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.
"resourceName": "A String", # Output only. The resource name of the visit. Visit resource names have the form: `customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}`
"visitDateTime": "A String", # Output only. The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
},
"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}`
},
},
"totalResultsCount": "A String", # Total number of results that match the query ignoring the LIMIT clause.
}

Search Ads 360 Reporting API . customers . searchAds360

Instance Methods

Method Details