@googleapis/searchads360 11.0.0 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v0.ts CHANGED
@@ -454,15 +454,15 @@ export namespace searchads360_v0 {
454
454
  */
455
455
  allConversions?: number | null;
456
456
  /**
457
- * 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.
457
+ * 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 [About the "All conversions" column](https://support.google.com/sa360/answer/9250611).
458
458
  */
459
459
  allConversionsByConversionDate?: number | null;
460
460
  /**
461
- * 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.
461
+ * The number of times people clicked the "Call" button to call a business 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.
462
462
  */
463
463
  allConversionsFromClickToCall?: number | null;
464
464
  /**
465
- * 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.
465
+ * The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only.
466
466
  */
467
467
  allConversionsFromDirections?: number | null;
468
468
  /**
@@ -474,23 +474,23 @@ export namespace searchads360_v0 {
474
474
  */
475
475
  allConversionsFromInteractionsValuePerInteraction?: number | null;
476
476
  /**
477
- * 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.
477
+ * The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only.
478
478
  */
479
479
  allConversionsFromMenu?: number | null;
480
480
  /**
481
- * The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
481
+ * The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.
482
482
  */
483
483
  allConversionsFromOrder?: number | null;
484
484
  /**
485
- * 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.
485
+ * The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only.
486
486
  */
487
487
  allConversionsFromOtherEngagement?: number | null;
488
488
  /**
489
- * Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
489
+ * Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.
490
490
  */
491
491
  allConversionsFromStoreVisit?: number | null;
492
492
  /**
493
- * The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
493
+ * The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.
494
494
  */
495
495
  allConversionsFromStoreWebsite?: number | null;
496
496
  /**
@@ -498,7 +498,7 @@ export namespace searchads360_v0 {
498
498
  */
499
499
  allConversionsValue?: number | null;
500
500
  /**
501
- * 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.
501
+ * 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 [About the "All conversions" column](https://support.google.com/sa360/answer/9250611).
502
502
  */
503
503
  allConversionsValueByConversionDate?: number | null;
504
504
  /**
@@ -514,11 +514,11 @@ export namespace searchads360_v0 {
514
514
  */
515
515
  averageCost?: number | null;
516
516
  /**
517
- * 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
517
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
518
518
  */
519
519
  averageCpc?: number | null;
520
520
  /**
521
- * 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
521
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
522
522
  */
523
523
  averageCpm?: number | null;
524
524
  /**
@@ -538,23 +538,23 @@ export namespace searchads360_v0 {
538
538
  */
539
539
  clicks?: string | null;
540
540
  /**
541
- * 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.
541
+ * 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.
542
542
  */
543
543
  clientAccountConversions?: number | null;
544
544
  /**
545
- * 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.
545
+ * 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.
546
546
  */
547
547
  clientAccountConversionsValue?: number | null;
548
548
  /**
549
- * 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
549
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
550
550
  */
551
551
  clientAccountCrossSellCostOfGoodsSoldMicros?: string | null;
552
552
  /**
553
- * 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
553
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
554
554
  */
555
555
  clientAccountCrossSellGrossProfitMicros?: string | null;
556
556
  /**
557
- * 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
557
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
558
558
  */
559
559
  clientAccountCrossSellRevenueMicros?: string | null;
560
560
  /**
@@ -562,15 +562,15 @@ export namespace searchads360_v0 {
562
562
  */
563
563
  clientAccountCrossSellUnitsSold?: number | null;
564
564
  /**
565
- * 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
565
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
566
566
  */
567
567
  clientAccountLeadCostOfGoodsSoldMicros?: string | null;
568
568
  /**
569
- * 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
569
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
570
570
  */
571
571
  clientAccountLeadGrossProfitMicros?: string | null;
572
572
  /**
573
- * 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
573
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
574
574
  */
575
575
  clientAccountLeadRevenueMicros?: string | null;
576
576
  /**
@@ -602,7 +602,7 @@ export namespace searchads360_v0 {
602
602
  */
603
603
  conversions?: number | null;
604
604
  /**
605
- * 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.
605
+ * 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 the date column mean the conversion date.
606
606
  */
607
607
  conversionsByConversionDate?: number | null;
608
608
  /**
@@ -610,7 +610,7 @@ export namespace searchads360_v0 {
610
610
  */
611
611
  conversionsFromInteractionsRate?: number | null;
612
612
  /**
613
- * 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.
613
+ * 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.
614
614
  */
615
615
  conversionsFromInteractionsValuePerInteraction?: number | null;
616
616
  /**
@@ -626,7 +626,7 @@ export namespace searchads360_v0 {
626
626
  */
627
627
  conversionsValuePerCost?: number | null;
628
628
  /**
629
- * 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
629
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause) for more details.
630
630
  */
631
631
  costMicros?: string | null;
632
632
  /**
@@ -642,15 +642,15 @@ export namespace searchads360_v0 {
642
642
  */
643
643
  costPerConversion?: number | null;
644
644
  /**
645
- * 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.
645
+ * 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.
646
646
  */
647
647
  costPerCurrentModelAttributedConversion?: number | null;
648
648
  /**
649
- * 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.
649
+ * 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`.
650
650
  */
651
651
  crossDeviceConversions?: number | null;
652
652
  /**
653
- * 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.
653
+ * The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611)
654
654
  */
655
655
  crossDeviceConversionsByConversionDate?: number | null;
656
656
  /**
@@ -658,19 +658,19 @@ export namespace searchads360_v0 {
658
658
  */
659
659
  crossDeviceConversionsValue?: number | null;
660
660
  /**
661
- * 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.
661
+ * The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [About the "All conversions" column](https://support.google.com/sa360/answer/9250611)
662
662
  */
663
663
  crossDeviceConversionsValueByConversionDate?: number | null;
664
664
  /**
665
- * 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
665
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
666
666
  */
667
667
  crossSellCostOfGoodsSoldMicros?: string | null;
668
668
  /**
669
- * 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
669
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
670
670
  */
671
671
  crossSellGrossProfitMicros?: string | null;
672
672
  /**
673
- * 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
673
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
674
674
  */
675
675
  crossSellRevenueMicros?: string | null;
676
676
  /**
@@ -682,11 +682,11 @@ export namespace searchads360_v0 {
682
682
  */
683
683
  ctr?: number | null;
684
684
  /**
685
- * 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.
685
+ * 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 [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
686
686
  */
687
687
  generalInvalidClickRate?: number | null;
688
688
  /**
689
- * 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.
689
+ * 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 [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
690
690
  */
691
691
  generalInvalidClicks?: string | null;
692
692
  /**
@@ -738,15 +738,15 @@ export namespace searchads360_v0 {
738
738
  */
739
739
  invalidClicks?: string | null;
740
740
  /**
741
- * 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
741
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
742
742
  */
743
743
  leadCostOfGoodsSoldMicros?: string | null;
744
744
  /**
745
- * 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
745
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
746
746
  */
747
747
  leadGrossProfitMicros?: string | null;
748
748
  /**
749
- * 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
749
+ * 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 [PARAMETERS clause](https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause).
750
750
  */
751
751
  leadRevenueMicros?: string | null;
752
752
  /**
@@ -770,7 +770,7 @@ export namespace searchads360_v0 {
770
770
  */
771
771
  revenueMicros?: string | null;
772
772
  /**
773
- * 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.
773
+ * The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/sa360/answer/9566729) for details. Any value below 0.1 is reported as 0.0999.
774
774
  */
775
775
  searchAbsoluteTopImpressionShare?: number | null;
776
776
  /**
@@ -782,7 +782,7 @@ export namespace searchads360_v0 {
782
782
  */
783
783
  searchBudgetLostImpressionShare?: number | null;
784
784
  /**
785
- * 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.
785
+ * The estimated percent of times that 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.
786
786
  */
787
787
  searchBudgetLostTopImpressionShare?: number | null;
788
788
  /**
@@ -830,7 +830,7 @@ export namespace searchads360_v0 {
830
830
  */
831
831
  valuePerAllConversions?: number | null;
832
832
  /**
833
- * 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.
833
+ * 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 [About the "All conversions" column](https://support.google.com/sa360/answer/9250611).
834
834
  */
835
835
  valuePerAllConversionsByConversionDate?: number | null;
836
836
  /**
@@ -899,7 +899,7 @@ export namespace searchads360_v0 {
899
899
  description2?: string | null;
900
900
  }
901
901
  /**
902
- * A Search Ads 360 expanded text ad.
902
+ * A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead.
903
903
  */
904
904
  export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo {
905
905
  /**
@@ -997,6 +997,10 @@ export namespace searchads360_v0 {
997
997
  * Segment only fields.
998
998
  */
999
999
  export interface Schema$GoogleAdsSearchads360V0Common__Segments {
1000
+ /**
1001
+ * Ad Format type.
1002
+ */
1003
+ adFormatType?: string | null;
1000
1004
  /**
1001
1005
  * Ad network type.
1002
1006
  */
@@ -1245,6 +1249,42 @@ export namespace searchads360_v0 {
1245
1249
  * The raw event conversion dimensions.
1246
1250
  */
1247
1251
  rawEventConversionDimensions?: Schema$GoogleAdsSearchads360V0Common__Value[];
1252
+ /**
1253
+ * The display names of participants in an event listing, like performers, speakers, or teams.
1254
+ */
1255
+ verticalAdsEventParticipantDisplayNames?: string | null;
1256
+ /**
1257
+ * The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.
1258
+ */
1259
+ verticalAdsHotelClass?: string | null;
1260
+ /**
1261
+ * The listing associated with a listing impression, click or conversion.
1262
+ */
1263
+ verticalAdsListing?: string | null;
1264
+ /**
1265
+ * The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event.
1266
+ */
1267
+ verticalAdsListingBrand?: string | null;
1268
+ /**
1269
+ * The city where the vertical ads listing is located.
1270
+ */
1271
+ verticalAdsListingCity?: string | null;
1272
+ /**
1273
+ * The country where the vertical ads listing is located.
1274
+ */
1275
+ verticalAdsListingCountry?: string | null;
1276
+ /**
1277
+ * The region where the vertical ads listing is located.
1278
+ */
1279
+ verticalAdsListingRegion?: string | null;
1280
+ /**
1281
+ * A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.
1282
+ */
1283
+ verticalAdsPartnerAccount?: string | null;
1284
+ /**
1285
+ * Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.
1286
+ */
1287
+ verticalAdsVertical?: string | null;
1248
1288
  /**
1249
1289
  * Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
1250
1290
  */
@@ -1254,6 +1294,32 @@ export namespace searchads360_v0 {
1254
1294
  */
1255
1295
  year?: number | null;
1256
1296
  }
1297
+ /**
1298
+ * Represents an attestation about synthetic content from a single source.
1299
+ */
1300
+ export interface Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation {
1301
+ /**
1302
+ * The source of the synthetic content attestation.
1303
+ */
1304
+ source?: string | null;
1305
+ /**
1306
+ * Indicates whether the content is considered synthetic by this source.
1307
+ */
1308
+ status?: string | null;
1309
+ }
1310
+ /**
1311
+ * Container for synthetic content attestations from different sources, such as the advertiser and Google systems.
1312
+ */
1313
+ export interface Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo {
1314
+ /**
1315
+ * Input provided by the advertiser.
1316
+ */
1317
+ advertiserAttestation?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation;
1318
+ /**
1319
+ * Output only. Information about synthetic content generated by Google's systems.
1320
+ */
1321
+ systemAttestation?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation;
1322
+ }
1257
1323
  /**
1258
1324
  * An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
1259
1325
  */
@@ -1879,11 +1945,11 @@ export namespace searchads360_v0 {
1879
1945
  */
1880
1946
  targetGoogleSearch?: boolean | null;
1881
1947
  /**
1882
- * Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
1948
+ * Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
1883
1949
  */
1884
1950
  targetPartnerSearchNetwork?: boolean | null;
1885
1951
  /**
1886
- * Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
1952
+ * Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
1887
1953
  */
1888
1954
  targetSearchNetwork?: boolean | null;
1889
1955
  }
@@ -2144,7 +2210,7 @@ export namespace searchads360_v0 {
2144
2210
  */
2145
2211
  expandedDynamicSearchAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo;
2146
2212
  /**
2147
- * Immutable. Details pertaining to an expanded text ad.
2213
+ * Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead.
2148
2214
  */
2149
2215
  expandedTextAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo;
2150
2216
  /**
@@ -2183,6 +2249,10 @@ export namespace searchads360_v0 {
2183
2249
  * Immutable. Details pertaining to a responsive search ad.
2184
2250
  */
2185
2251
  responsiveSearchAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo;
2252
+ /**
2253
+ * Synthetic content info for the ad. Only ads with specific ad types are eligible for updates using the `synthetic_content_info` field. Allowed `AdType` values: * `HTML5_UPLOAD_AD` * `DYNAMIC_HTML5_AD` * `IMAGE_AD`
2254
+ */
2255
+ syntheticContentInfo?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo;
2186
2256
  /**
2187
2257
  * Immutable. Details pertaining to a text ad.
2188
2258
  */
@@ -2205,7 +2275,7 @@ export namespace searchads360_v0 {
2205
2275
  */
2206
2276
  adRotationMode?: string | null;
2207
2277
  /**
2208
- * The maximum CPC (cost-per-click) bid.
2278
+ * The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.
2209
2279
  */
2210
2280
  cpcBidMicros?: string | null;
2211
2281
  /**
@@ -2634,7 +2704,7 @@ export namespace searchads360_v0 {
2634
2704
  resourceName?: string | null;
2635
2705
  }
2636
2706
  /**
2637
- * An age range view.
2707
+ * An age range view. Represents the view of a customer's performance metrics (like impressions and clicks) aggregated by age range. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.
2638
2708
  */
2639
2709
  export interface Schema$GoogleAdsSearchads360V0Resources__AgeRangeView {
2640
2710
  /**
@@ -2718,6 +2788,10 @@ export namespace searchads360_v0 {
2718
2788
  * Output only. The status of the asset.
2719
2789
  */
2720
2790
  status?: string | null;
2791
+ /**
2792
+ * Synthetic content info for the asset. Only assets with specific asset types are eligible for updates using the `synthetic_content_info` field. Allowed `AssetType` values: * `IMAGE` * `MEDIA_BUNDLE` * `YOUTUBE_VIDEO`
2793
+ */
2794
+ syntheticContentInfo?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo;
2721
2795
  /**
2722
2796
  * Output only. A text asset.
2723
2797
  */
@@ -3262,7 +3336,7 @@ export namespace searchads360_v0 {
3262
3336
  */
3263
3337
  export interface Schema$GoogleAdsSearchads360V0Resources__CampaignBudget {
3264
3338
  /**
3265
- * 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.
3339
+ * The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set.
3266
3340
  */
3267
3341
  amountMicros?: string | null;
3268
3342
  /**
@@ -3394,7 +3468,7 @@ export namespace searchads360_v0 {
3394
3468
  resourceName?: string | null;
3395
3469
  }
3396
3470
  /**
3397
- * Cart data sales view.
3471
+ * Cart data sales view. Provides information about the products which were purchased if conversions with cart data is implemented. Performance metrics like revenue, gross profit, lead/cross-sell metrics etc. and Merchant Center attributes such as brand, category etc. are available for products defined in an inventory feed and sold as a result of Google ads. For purchases attributed to clicks on Shopping ads, dimensions of both clicked and sold products can be viewed together.
3398
3472
  */
3399
3473
  export interface Schema$GoogleAdsSearchads360V0Resources__CartDataSalesView {
3400
3474
  /**
@@ -3943,7 +4017,7 @@ export namespace searchads360_v0 {
3943
4017
  resourceName?: string | null;
3944
4018
  }
3945
4019
  /**
3946
- * 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.
4020
+ * A gender view resource. Represents the view of a customer's performance metrics aggregated by gender. All statistics are aggregated at the ad group level. Note: While you can segment metrics by age range using `age_range_view` or by gender using `gender_view`, the Search Ads 360 API does not support segmenting metrics by both age range and gender simultaneously in a single query. Analyzing performance across both dimensions combined is not supported in the Search Ads 360 API.
3947
4021
  */
3948
4022
  export interface Schema$GoogleAdsSearchads360V0Resources__GenderView {
3949
4023
  /**
@@ -4215,7 +4289,7 @@ export namespace searchads360_v0 {
4215
4289
  resourceName?: string | null;
4216
4290
  }
4217
4291
  /**
4218
- * A user list. This is a list of users a customer may target.
4292
+ * A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`.
4219
4293
  */
4220
4294
  export interface Schema$GoogleAdsSearchads360V0Resources__UserList {
4221
4295
  /**
@@ -4223,7 +4297,7 @@ export namespace searchads360_v0 {
4223
4297
  */
4224
4298
  id?: string | null;
4225
4299
  /**
4226
- * Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
4300
+ * Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`.
4227
4301
  */
4228
4302
  name?: string | null;
4229
4303
  /**
@@ -4758,6 +4832,1125 @@ export namespace searchads360_v0 {
4758
4832
  */
4759
4833
  totalResultsCount?: string | null;
4760
4834
  }
4835
+ /**
4836
+ * Indicates that a resource's ability to serve in a particular country is constrained.
4837
+ */
4838
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint {
4839
+ /**
4840
+ * Geo target constant resource name of the country in which serving is constrained.
4841
+ */
4842
+ countryCriterion?: string | null;
4843
+ }
4844
+ /**
4845
+ * A list of countries where a resource's serving is constrained.
4846
+ */
4847
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList {
4848
+ /**
4849
+ * Countries in which serving is restricted.
4850
+ */
4851
+ countries?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint[];
4852
+ /**
4853
+ * Total number of countries targeted by the resource.
4854
+ */
4855
+ totalTargetedCountries?: number | null;
4856
+ }
4857
+ /**
4858
+ * Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.
4859
+ */
4860
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint {}
4861
+ /**
4862
+ * Evidence of mismatches between the URLs of a resource.
4863
+ */
4864
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch {
4865
+ /**
4866
+ * The set of URLs that did not match each other.
4867
+ */
4868
+ urlTypes?: string[] | null;
4869
+ }
4870
+ /**
4871
+ * Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
4872
+ */
4873
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking {
4874
+ /**
4875
+ * The type of device that failed to load the URL.
4876
+ */
4877
+ device?: string | null;
4878
+ /**
4879
+ * The type of DNS error.
4880
+ */
4881
+ dnsErrorType?: string | null;
4882
+ /**
4883
+ * The full URL that didn't work.
4884
+ */
4885
+ expandedUrl?: string | null;
4886
+ /**
4887
+ * The HTTP error code.
4888
+ */
4889
+ httpErrorCode?: string | null;
4890
+ /**
4891
+ * The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
4892
+ */
4893
+ lastCheckedDateTime?: string | null;
4894
+ }
4895
+ /**
4896
+ * A list of strings found in a destination page that caused a policy finding.
4897
+ */
4898
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList {
4899
+ /**
4900
+ * List of text found in the resource's destination page.
4901
+ */
4902
+ destinationTexts?: string[] | null;
4903
+ }
4904
+ /**
4905
+ * A list of fragments of text that violated a policy.
4906
+ */
4907
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList {
4908
+ /**
4909
+ * The fragments of text from the resource that caused the policy finding.
4910
+ */
4911
+ texts?: string[] | null;
4912
+ }
4913
+ /**
4914
+ * A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.
4915
+ */
4916
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList {
4917
+ /**
4918
+ * Websites that caused the policy finding.
4919
+ */
4920
+ websites?: string[] | null;
4921
+ }
4922
+ /**
4923
+ * Describes the effect on serving that a policy topic entry will have.
4924
+ */
4925
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicConstraint {
4926
+ /**
4927
+ * Countries where the resource's domain is not covered by the certificates associated with it.
4928
+ */
4929
+ certificateDomainMismatchInCountryList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4930
+ /**
4931
+ * Countries where a certificate is required for serving.
4932
+ */
4933
+ certificateMissingInCountryList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4934
+ /**
4935
+ * Countries where the resource cannot serve.
4936
+ */
4937
+ countryConstraintList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4938
+ /**
4939
+ * Reseller constraint.
4940
+ */
4941
+ resellerConstraint?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint;
4942
+ }
4943
+ /**
4944
+ * Policy finding attached to a resource (for example, alcohol policy associated with a site that sells alcohol). Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted.
4945
+ */
4946
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicEntry {
4947
+ /**
4948
+ * Indicates how serving of this resource may be affected (for example, not serving in a country).
4949
+ */
4950
+ constraints?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicConstraint[];
4951
+ /**
4952
+ * Additional information that explains policy finding (for example, the brand name for a trademark finding).
4953
+ */
4954
+ evidences?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicEvidence[];
4955
+ /**
4956
+ * Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.
4957
+ */
4958
+ topic?: string | null;
4959
+ /**
4960
+ * Describes the negative or positive effect this policy will have on serving.
4961
+ */
4962
+ type?: string | null;
4963
+ }
4964
+ /**
4965
+ * Additional information that explains a policy finding.
4966
+ */
4967
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicEvidence {
4968
+ /**
4969
+ * Mismatch between the destinations of a resource's URLs.
4970
+ */
4971
+ destinationMismatch?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch;
4972
+ /**
4973
+ * Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
4974
+ */
4975
+ destinationNotWorking?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking;
4976
+ /**
4977
+ * The text in the destination of the resource that is causing a policy finding.
4978
+ */
4979
+ destinationTextList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList;
4980
+ /**
4981
+ * The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
4982
+ */
4983
+ languageCode?: string | null;
4984
+ /**
4985
+ * List of evidence found in the text of a resource.
4986
+ */
4987
+ textList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList;
4988
+ /**
4989
+ * List of websites linked with this resource.
4990
+ */
4991
+ websiteList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList;
4992
+ }
4993
+ /**
4994
+ * Key of the violation. The key is used for referring to a violation when filing an exemption request.
4995
+ */
4996
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyViolationKey {
4997
+ /**
4998
+ * Unique ID of the violated policy.
4999
+ */
5000
+ policyName?: string | null;
5001
+ /**
5002
+ * The text that violates the policy if specified. Otherwise, refers to the policy in general (for example, when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.
5003
+ */
5004
+ violatingText?: string | null;
5005
+ }
5006
+ /**
5007
+ * A generic data container.
5008
+ */
5009
+ export interface Schema$GoogleAdsSearchads360V23Common__Value {
5010
+ /**
5011
+ * A boolean.
5012
+ */
5013
+ booleanValue?: boolean | null;
5014
+ /**
5015
+ * A double.
5016
+ */
5017
+ doubleValue?: number | null;
5018
+ /**
5019
+ * A float.
5020
+ */
5021
+ floatValue?: number | null;
5022
+ /**
5023
+ * An int64.
5024
+ */
5025
+ int64Value?: string | null;
5026
+ /**
5027
+ * A string.
5028
+ */
5029
+ stringValue?: string | null;
5030
+ }
5031
+ /**
5032
+ * A part of a field path.
5033
+ */
5034
+ export interface Schema$GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement {
5035
+ /**
5036
+ * The name of a field or a oneof
5037
+ */
5038
+ fieldName?: string | null;
5039
+ /**
5040
+ * If field_name is a repeated field, this is the element that failed
5041
+ */
5042
+ index?: number | null;
5043
+ }
5044
+ /**
5045
+ * Error details for a budget below per-day minimum error.
5046
+ */
5047
+ export interface Schema$GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails {
5048
+ /**
5049
+ * The minimum budget required by the campaign per day, in micros of the advertiser currency. Applies to both daily and custom budgets.
5050
+ */
5051
+ budgetPerDayMinimumMicros?: string | null;
5052
+ /**
5053
+ * The advertiser's currency, represented as a three-letter ISO 4217 currency code (such as "USD").
5054
+ */
5055
+ currencyCode?: string | null;
5056
+ /**
5057
+ * The budget amount value that was rejected as too low, in micros of the advertiser currency. Only set if this error is caused by the amount field value.
5058
+ */
5059
+ failedBudgetAmountMicros?: string | null;
5060
+ /**
5061
+ * The budget total_amount value that was rejected as too low, in micros of the advertiser currency. Only set if this error is caused by the total_amount field value.
5062
+ */
5063
+ failedBudgetTotalAmountMicros?: string | null;
5064
+ /**
5065
+ * The minimum value for the budget's amount field required by the campaign, in micros of the advertiser currency. Only set if this error is caused by the amount field value.
5066
+ */
5067
+ minimumBudgetAmountMicros?: string | null;
5068
+ /**
5069
+ * The minimum value for the budget's total_amount field required by the campaign given its configured start and end time, in micros of the advertiser currency. Only set if this error is caused by the total_amount field value.
5070
+ */
5071
+ minimumBudgetTotalAmountMicros?: string | null;
5072
+ }
5073
+ /**
5074
+ * The error reason represented by type and enum.
5075
+ */
5076
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorCode {
5077
+ /**
5078
+ * The reasons for the access invitation error
5079
+ */
5080
+ accessInvitationError?: string | null;
5081
+ /**
5082
+ * The reasons for account budget proposal errors.
5083
+ */
5084
+ accountBudgetProposalError?: string | null;
5085
+ /**
5086
+ * The reasons for the account link status change error
5087
+ */
5088
+ accountLinkError?: string | null;
5089
+ /**
5090
+ * The reasons for the ad customizer error
5091
+ */
5092
+ adCustomizerError?: string | null;
5093
+ /**
5094
+ * An error with an Ad Group Ad mutate.
5095
+ */
5096
+ adError?: string | null;
5097
+ /**
5098
+ * The reasons for the ad group ad error
5099
+ */
5100
+ adGroupAdError?: string | null;
5101
+ /**
5102
+ * The reasons for the ad group bid modifier error
5103
+ */
5104
+ adGroupBidModifierError?: string | null;
5105
+ /**
5106
+ * The reasons for the ad group criterion customizer error.
5107
+ */
5108
+ adGroupCriterionCustomizerError?: string | null;
5109
+ /**
5110
+ * Indicates failure to properly authenticate user.
5111
+ */
5112
+ adGroupCriterionError?: string | null;
5113
+ /**
5114
+ * The reasons for the ad group customizer error.
5115
+ */
5116
+ adGroupCustomizerError?: string | null;
5117
+ /**
5118
+ * An error with an Ad Group mutate.
5119
+ */
5120
+ adGroupError?: string | null;
5121
+ /**
5122
+ * The reasons for the ad group feed error
5123
+ */
5124
+ adGroupFeedError?: string | null;
5125
+ /**
5126
+ * The reasons for the ad parameter error
5127
+ */
5128
+ adParameterError?: string | null;
5129
+ /**
5130
+ * The reasons for the ad sharing error
5131
+ */
5132
+ adSharingError?: string | null;
5133
+ /**
5134
+ * The reasons for the adx error
5135
+ */
5136
+ adxError?: string | null;
5137
+ /**
5138
+ * The reasons for the asset error
5139
+ */
5140
+ assetError?: string | null;
5141
+ /**
5142
+ * The reasons for the GenAI asset generation error.
5143
+ */
5144
+ assetGenerationError?: string | null;
5145
+ /**
5146
+ * The reasons for the asset group asset error
5147
+ */
5148
+ assetGroupAssetError?: string | null;
5149
+ /**
5150
+ * The reasons for the asset group error
5151
+ */
5152
+ assetGroupError?: string | null;
5153
+ /**
5154
+ * The reasons for the asset group listing group filter error
5155
+ */
5156
+ assetGroupListingGroupFilterError?: string | null;
5157
+ /**
5158
+ * The reasons for the asset group hint error
5159
+ */
5160
+ assetGroupSignalError?: string | null;
5161
+ /**
5162
+ * The reasons for the asset link error
5163
+ */
5164
+ assetLinkError?: string | null;
5165
+ /**
5166
+ * The reasons for the asset set asset error
5167
+ */
5168
+ assetSetAssetError?: string | null;
5169
+ /**
5170
+ * The reasons for the asset set error
5171
+ */
5172
+ assetSetError?: string | null;
5173
+ /**
5174
+ * The reasons for the asset set link error
5175
+ */
5176
+ assetSetLinkError?: string | null;
5177
+ /**
5178
+ * The reasons for the audience error
5179
+ */
5180
+ audienceError?: string | null;
5181
+ /**
5182
+ * The reasons for the Audience Insights error
5183
+ */
5184
+ audienceInsightsError?: string | null;
5185
+ /**
5186
+ * Indicates failure to properly authenticate user.
5187
+ */
5188
+ authenticationError?: string | null;
5189
+ /**
5190
+ * An error encountered when trying to authorize a user.
5191
+ */
5192
+ authorizationError?: string | null;
5193
+ /**
5194
+ * The reasons for error in automatically created asset removal action.
5195
+ */
5196
+ automaticallyCreatedAssetRemovalError?: string | null;
5197
+ /**
5198
+ * The reasons for the batch job error
5199
+ */
5200
+ batchJobError?: string | null;
5201
+ /**
5202
+ * The reasons for the Benchmarks error.
5203
+ */
5204
+ benchmarksError?: string | null;
5205
+ /**
5206
+ * The reasons for the bidding errors
5207
+ */
5208
+ biddingError?: string | null;
5209
+ /**
5210
+ * An error with a Bidding Strategy mutate.
5211
+ */
5212
+ biddingStrategyError?: string | null;
5213
+ /**
5214
+ * The reasons for the billing setup error
5215
+ */
5216
+ billingSetupError?: string | null;
5217
+ /**
5218
+ * The reasons for the brand guidelines migration error.
5219
+ */
5220
+ brandGuidelinesMigrationError?: string | null;
5221
+ /**
5222
+ * An error with a Campaign Budget mutate.
5223
+ */
5224
+ campaignBudgetError?: string | null;
5225
+ /**
5226
+ * The reasons for the campaign conversion goal error
5227
+ */
5228
+ campaignConversionGoalError?: string | null;
5229
+ /**
5230
+ * The reasons for the campaign criterion error
5231
+ */
5232
+ campaignCriterionError?: string | null;
5233
+ /**
5234
+ * The reasons for the campaign customizer error.
5235
+ */
5236
+ campaignCustomizerError?: string | null;
5237
+ /**
5238
+ * The reasons for the campaign draft error
5239
+ */
5240
+ campaignDraftError?: string | null;
5241
+ /**
5242
+ * An error with a Campaign mutate.
5243
+ */
5244
+ campaignError?: string | null;
5245
+ /**
5246
+ * The reasons for the campaign experiment error
5247
+ */
5248
+ campaignExperimentError?: string | null;
5249
+ /**
5250
+ * The reasons for the campaign feed error
5251
+ */
5252
+ campaignFeedError?: string | null;
5253
+ /**
5254
+ * The reasons for the campaign goal config error.
5255
+ */
5256
+ campaignGoalConfigError?: string | null;
5257
+ /**
5258
+ * The reasons for the campaign lifecycle goal error
5259
+ */
5260
+ campaignLifecycleGoalError?: string | null;
5261
+ /**
5262
+ * The reasons for the campaign shared set error
5263
+ */
5264
+ campaignSharedSetError?: string | null;
5265
+ /**
5266
+ * The reasons for the change event error
5267
+ */
5268
+ changeEventError?: string | null;
5269
+ /**
5270
+ * The reasons for the change status error
5271
+ */
5272
+ changeStatusError?: string | null;
5273
+ /**
5274
+ * The reasons for the click view error
5275
+ */
5276
+ clickViewError?: string | null;
5277
+ /**
5278
+ * The reasons for the collection size error
5279
+ */
5280
+ collectionSizeError?: string | null;
5281
+ /**
5282
+ * The reasons for the context error
5283
+ */
5284
+ contextError?: string | null;
5285
+ /**
5286
+ * The reasons for the conversion action error
5287
+ */
5288
+ conversionActionError?: string | null;
5289
+ /**
5290
+ * The reasons for the conversion adjustment upload error
5291
+ */
5292
+ conversionAdjustmentUploadError?: string | null;
5293
+ /**
5294
+ * The reasons for the conversion custom variable error
5295
+ */
5296
+ conversionCustomVariableError?: string | null;
5297
+ /**
5298
+ * The reasons for the conversion goal campaign config error
5299
+ */
5300
+ conversionGoalCampaignConfigError?: string | null;
5301
+ /**
5302
+ * The reasons for the conversion upload error
5303
+ */
5304
+ conversionUploadError?: string | null;
5305
+ /**
5306
+ * The reasons for the conversion value rule error
5307
+ */
5308
+ conversionValueRuleError?: string | null;
5309
+ /**
5310
+ * The reasons for the conversion value rule set error
5311
+ */
5312
+ conversionValueRuleSetError?: string | null;
5313
+ /**
5314
+ * The reasons for the country code error
5315
+ */
5316
+ countryCodeError?: string | null;
5317
+ /**
5318
+ * The reasons for the criterion error
5319
+ */
5320
+ criterionError?: string | null;
5321
+ /**
5322
+ * The reasons for the currency code error
5323
+ */
5324
+ currencyCodeError?: string | null;
5325
+ /**
5326
+ * The reasons for the currency errors.
5327
+ */
5328
+ currencyError?: string | null;
5329
+ /**
5330
+ * The reasons for the custom audience error
5331
+ */
5332
+ customAudienceError?: string | null;
5333
+ /**
5334
+ * The reasons for the custom column error
5335
+ */
5336
+ customColumnError?: string | null;
5337
+ /**
5338
+ * The reasons for the custom conversion goal error
5339
+ */
5340
+ customConversionGoalError?: string | null;
5341
+ /**
5342
+ * The reasons for the customer client link error
5343
+ */
5344
+ customerClientLinkError?: string | null;
5345
+ /**
5346
+ * The reasons for the customer customizer error.
5347
+ */
5348
+ customerCustomizerError?: string | null;
5349
+ /**
5350
+ * The reasons for the customer error
5351
+ */
5352
+ customerError?: string | null;
5353
+ /**
5354
+ * The reasons for the customer feed error
5355
+ */
5356
+ customerFeedError?: string | null;
5357
+ /**
5358
+ * The reasons for the customer lifecycle goal error
5359
+ */
5360
+ customerLifecycleGoalError?: string | null;
5361
+ /**
5362
+ * The reasons for the customer manager link error
5363
+ */
5364
+ customerManagerLinkError?: string | null;
5365
+ /**
5366
+ * The reasons for the customer SK Ad network conversion value schema error
5367
+ */
5368
+ customerSkAdNetworkConversionValueSchemaError?: string | null;
5369
+ /**
5370
+ * The reasons for the customer user access mutate error
5371
+ */
5372
+ customerUserAccessError?: string | null;
5373
+ /**
5374
+ * The reasons for the custom interest error
5375
+ */
5376
+ customInterestError?: string | null;
5377
+ /**
5378
+ * The reasons for the customizer attribute error.
5379
+ */
5380
+ customizerAttributeError?: string | null;
5381
+ /**
5382
+ * The reasons for the database error.
5383
+ */
5384
+ databaseError?: string | null;
5385
+ /**
5386
+ * The reasons for the data link error
5387
+ */
5388
+ dataLinkError?: string | null;
5389
+ /**
5390
+ * The reasons for the date error
5391
+ */
5392
+ dateError?: string | null;
5393
+ /**
5394
+ * The reasons for the date range error
5395
+ */
5396
+ dateRangeError?: string | null;
5397
+ /**
5398
+ * The reasons for the distinct error
5399
+ */
5400
+ distinctError?: string | null;
5401
+ /**
5402
+ * The reason for enum error.
5403
+ */
5404
+ enumError?: string | null;
5405
+ /**
5406
+ * The reasons for the experiment arm error
5407
+ */
5408
+ experimentArmError?: string | null;
5409
+ /**
5410
+ * The reasons for the experiment error
5411
+ */
5412
+ experimentError?: string | null;
5413
+ /**
5414
+ * The reasons for the extension feed item error
5415
+ */
5416
+ extensionFeedItemError?: string | null;
5417
+ /**
5418
+ * The reasons for the extension setting error
5419
+ */
5420
+ extensionSettingError?: string | null;
5421
+ /**
5422
+ * The reasons for the feed attribute reference error
5423
+ */
5424
+ feedAttributeReferenceError?: string | null;
5425
+ /**
5426
+ * The reasons for the feed error
5427
+ */
5428
+ feedError?: string | null;
5429
+ /**
5430
+ * The reasons for the feed item error
5431
+ */
5432
+ feedItemError?: string | null;
5433
+ /**
5434
+ * The reasons for the feed item set error
5435
+ */
5436
+ feedItemSetError?: string | null;
5437
+ /**
5438
+ * The reasons for the feed item set link error
5439
+ */
5440
+ feedItemSetLinkError?: string | null;
5441
+ /**
5442
+ * The reasons for the feed item target error
5443
+ */
5444
+ feedItemTargetError?: string | null;
5445
+ /**
5446
+ * The reasons for the feed item validation error
5447
+ */
5448
+ feedItemValidationError?: string | null;
5449
+ /**
5450
+ * The reasons for the feed mapping error
5451
+ */
5452
+ feedMappingError?: string | null;
5453
+ /**
5454
+ * The reasons for the field error
5455
+ */
5456
+ fieldError?: string | null;
5457
+ /**
5458
+ * An error with a field mask
5459
+ */
5460
+ fieldMaskError?: string | null;
5461
+ /**
5462
+ * The reasons for the final url expansion asset view error
5463
+ */
5464
+ finalUrlExpansionAssetViewError?: string | null;
5465
+ /**
5466
+ * The reasons for the function error
5467
+ */
5468
+ functionError?: string | null;
5469
+ /**
5470
+ * The reasons for the function parsing error
5471
+ */
5472
+ functionParsingError?: string | null;
5473
+ /**
5474
+ * The reasons for the geo target constant suggestion error.
5475
+ */
5476
+ geoTargetConstantSuggestionError?: string | null;
5477
+ /**
5478
+ * The reasons for the goal error.
5479
+ */
5480
+ goalError?: string | null;
5481
+ /**
5482
+ * The reasons for the header error.
5483
+ */
5484
+ headerError?: string | null;
5485
+ /**
5486
+ * The reasons for an identity verification error.
5487
+ */
5488
+ identityVerificationError?: string | null;
5489
+ /**
5490
+ * The reasons for the id error
5491
+ */
5492
+ idError?: string | null;
5493
+ /**
5494
+ * The reasons for the image error
5495
+ */
5496
+ imageError?: string | null;
5497
+ /**
5498
+ * The reasons for the incentive error
5499
+ */
5500
+ incentiveError?: string | null;
5501
+ /**
5502
+ * An unexpected server-side error.
5503
+ */
5504
+ internalError?: string | null;
5505
+ /**
5506
+ * The reasons for invalid parameter errors.
5507
+ */
5508
+ invalidParameterError?: string | null;
5509
+ /**
5510
+ * The reasons for the invoice error
5511
+ */
5512
+ invoiceError?: string | null;
5513
+ /**
5514
+ * The reason for keyword plan ad group error.
5515
+ */
5516
+ keywordPlanAdGroupError?: string | null;
5517
+ /**
5518
+ * The reason for keyword plan ad group keyword error.
5519
+ */
5520
+ keywordPlanAdGroupKeywordError?: string | null;
5521
+ /**
5522
+ * The reason for keyword plan campaign error.
5523
+ */
5524
+ keywordPlanCampaignError?: string | null;
5525
+ /**
5526
+ * The reason for keyword plan campaign keyword error.
5527
+ */
5528
+ keywordPlanCampaignKeywordError?: string | null;
5529
+ /**
5530
+ * The reason for keyword plan error.
5531
+ */
5532
+ keywordPlanError?: string | null;
5533
+ /**
5534
+ * The reason for keyword idea error.
5535
+ */
5536
+ keywordPlanIdeaError?: string | null;
5537
+ /**
5538
+ * The reason for the label error.
5539
+ */
5540
+ labelError?: string | null;
5541
+ /**
5542
+ * The reasons for the language code error
5543
+ */
5544
+ languageCodeError?: string | null;
5545
+ /**
5546
+ * An error with a list operation.
5547
+ */
5548
+ listOperationError?: string | null;
5549
+ /**
5550
+ * The reasons for the manager link error
5551
+ */
5552
+ managerLinkError?: string | null;
5553
+ /**
5554
+ * The reasons for the media bundle error
5555
+ */
5556
+ mediaBundleError?: string | null;
5557
+ /**
5558
+ * The reasons for the media file error
5559
+ */
5560
+ mediaFileError?: string | null;
5561
+ /**
5562
+ * The reasons for media uploading errors.
5563
+ */
5564
+ mediaUploadError?: string | null;
5565
+ /**
5566
+ * Container for enum describing possible merchant center errors.
5567
+ */
5568
+ merchantCenterError?: string | null;
5569
+ /**
5570
+ * The reasons for the multiplier error
5571
+ */
5572
+ multiplierError?: string | null;
5573
+ /**
5574
+ * An error with a mutate
5575
+ */
5576
+ mutateError?: string | null;
5577
+ /**
5578
+ * The reasons for the new resource creation error
5579
+ */
5580
+ newResourceCreationError?: string | null;
5581
+ /**
5582
+ * The reasons for the not allowlisted error
5583
+ */
5584
+ notAllowlistedError?: string | null;
5585
+ /**
5586
+ * The reasons for the not empty error
5587
+ */
5588
+ notEmptyError?: string | null;
5589
+ /**
5590
+ * The reasons for the null error
5591
+ */
5592
+ nullError?: string | null;
5593
+ /**
5594
+ * The reasons for the offline user data job error.
5595
+ */
5596
+ offlineUserDataJobError?: string | null;
5597
+ /**
5598
+ * The reasons for the operation access denied error
5599
+ */
5600
+ operationAccessDeniedError?: string | null;
5601
+ /**
5602
+ * The reasons for the operator error
5603
+ */
5604
+ operatorError?: string | null;
5605
+ /**
5606
+ * The reasons for the mutate job error
5607
+ */
5608
+ partialFailureError?: string | null;
5609
+ /**
5610
+ * The reasons for errors in payments accounts service
5611
+ */
5612
+ paymentsAccountError?: string | null;
5613
+ /**
5614
+ * The reasons for the policy finding error.
5615
+ */
5616
+ policyFindingError?: string | null;
5617
+ /**
5618
+ * The reasons for the policy validation parameter error
5619
+ */
5620
+ policyValidationParameterError?: string | null;
5621
+ /**
5622
+ * The reasons for the policy violation error
5623
+ */
5624
+ policyViolationError?: string | null;
5625
+ /**
5626
+ * The reasons for the product link error
5627
+ */
5628
+ productLinkError?: string | null;
5629
+ /**
5630
+ * The reasons for the product link invitation error
5631
+ */
5632
+ productLinkInvitationError?: string | null;
5633
+ /**
5634
+ * An error with the query
5635
+ */
5636
+ queryError?: string | null;
5637
+ /**
5638
+ * An error with the amount of quota remaining.
5639
+ */
5640
+ quotaError?: string | null;
5641
+ /**
5642
+ * The reasons for the range error
5643
+ */
5644
+ rangeError?: string | null;
5645
+ /**
5646
+ * The reasons for the reach plan error
5647
+ */
5648
+ reachPlanError?: string | null;
5649
+ /**
5650
+ * The reasons for error in applying a recommendation
5651
+ */
5652
+ recommendationError?: string | null;
5653
+ /**
5654
+ * The reasons for the recommendation subscription error.
5655
+ */
5656
+ recommendationSubscriptionError?: string | null;
5657
+ /**
5658
+ * The reasons for the region code error
5659
+ */
5660
+ regionCodeError?: string | null;
5661
+ /**
5662
+ * An error caused by the request
5663
+ */
5664
+ requestError?: string | null;
5665
+ /**
5666
+ * The reasons for the resource access denied error
5667
+ */
5668
+ resourceAccessDeniedError?: string | null;
5669
+ /**
5670
+ * The reasons for the resource count limit exceeded error
5671
+ */
5672
+ resourceCountLimitExceededError?: string | null;
5673
+ /**
5674
+ * The reasons for the Search term insight error
5675
+ */
5676
+ searchTermInsightError?: string | null;
5677
+ /**
5678
+ * The reasons for the setting error
5679
+ */
5680
+ settingError?: string | null;
5681
+ /**
5682
+ * The reasons for the shareable preview error.
5683
+ */
5684
+ shareablePreviewError?: string | null;
5685
+ /**
5686
+ * The reasons for the shared criterion error
5687
+ */
5688
+ sharedCriterionError?: string | null;
5689
+ /**
5690
+ * The reasons for the shared set error
5691
+ */
5692
+ sharedSetError?: string | null;
5693
+ /**
5694
+ * The reasons for error in querying shopping product.
5695
+ */
5696
+ shoppingProductError?: string | null;
5697
+ /**
5698
+ * The reasons for the size limit error
5699
+ */
5700
+ sizeLimitError?: string | null;
5701
+ /**
5702
+ * The reasons for the Smart campaign error
5703
+ */
5704
+ smartCampaignError?: string | null;
5705
+ /**
5706
+ * The reasons for the string format error
5707
+ */
5708
+ stringFormatError?: string | null;
5709
+ /**
5710
+ * The reasons for the string length error
5711
+ */
5712
+ stringLengthError?: string | null;
5713
+ /**
5714
+ * The reasons for the third party app analytics link mutate error
5715
+ */
5716
+ thirdPartyAppAnalyticsLinkError?: string | null;
5717
+ /**
5718
+ * The reasons for the time zone error
5719
+ */
5720
+ timeZoneError?: string | null;
5721
+ /**
5722
+ * An error with a URL field mutate.
5723
+ */
5724
+ urlFieldError?: string | null;
5725
+ /**
5726
+ * The reasons for the user data error.
5727
+ */
5728
+ userDataError?: string | null;
5729
+ /**
5730
+ * The reasons for a user list customer type error.
5731
+ */
5732
+ userListCustomerTypeError?: string | null;
5733
+ /**
5734
+ * The reasons for the user list error
5735
+ */
5736
+ userListError?: string | null;
5737
+ /**
5738
+ * An error with a Video Campaign mutate.
5739
+ */
5740
+ videoCampaignError?: string | null;
5741
+ /**
5742
+ * The reasons for YouTube video registration errors.
5743
+ */
5744
+ youtubeVideoRegistrationError?: string | null;
5745
+ }
5746
+ /**
5747
+ * Additional error details.
5748
+ */
5749
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorDetails {
5750
+ /**
5751
+ * Details for a budget below per-day minimum error.
5752
+ */
5753
+ budgetPerDayMinimumErrorDetails?: Schema$GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails;
5754
+ /**
5755
+ * Describes policy violation findings.
5756
+ */
5757
+ policyFindingDetails?: Schema$GoogleAdsSearchads360V23Errors__PolicyFindingDetails;
5758
+ /**
5759
+ * Describes an ad policy violation.
5760
+ */
5761
+ policyViolationDetails?: Schema$GoogleAdsSearchads360V23Errors__PolicyViolationDetails;
5762
+ /**
5763
+ * Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.
5764
+ */
5765
+ quotaErrorDetails?: Schema$GoogleAdsSearchads360V23Errors__QuotaErrorDetails;
5766
+ /**
5767
+ * Details for a resource count limit exceeded error.
5768
+ */
5769
+ resourceCountDetails?: Schema$GoogleAdsSearchads360V23Errors__ResourceCountDetails;
5770
+ /**
5771
+ * The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.
5772
+ */
5773
+ unpublishedErrorCode?: string | null;
5774
+ }
5775
+ /**
5776
+ * Describes the part of the request proto that caused the error.
5777
+ */
5778
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorLocation {
5779
+ /**
5780
+ * A field path that indicates which field was invalid in the request.
5781
+ */
5782
+ fieldPathElements?: Schema$GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement[];
5783
+ }
5784
+ /**
5785
+ * Error returned as part of a mutate response. This error indicates one or more policy findings in the fields of a resource.
5786
+ */
5787
+ export interface Schema$GoogleAdsSearchads360V23Errors__PolicyFindingDetails {
5788
+ /**
5789
+ * The list of policy topics for the resource. Contains the PROHIBITED or FULLY_LIMITED policy topic entries that prevented the resource from being saved (among any other entries the resource may also have).
5790
+ */
5791
+ policyTopicEntries?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicEntry[];
5792
+ }
5793
+ /**
5794
+ * Error returned as part of a mutate response. This error indicates single policy violation by some text in one of the fields.
5795
+ */
5796
+ export interface Schema$GoogleAdsSearchads360V23Errors__PolicyViolationDetails {
5797
+ /**
5798
+ * Human readable description of policy violation.
5799
+ */
5800
+ externalPolicyDescription?: string | null;
5801
+ /**
5802
+ * Human readable name of the policy.
5803
+ */
5804
+ externalPolicyName?: string | null;
5805
+ /**
5806
+ * Whether user can file an exemption request for this violation.
5807
+ */
5808
+ isExemptible?: boolean | null;
5809
+ /**
5810
+ * Unique identifier for this violation. If policy is exemptible, this key may be used to request exemption.
5811
+ */
5812
+ key?: Schema$GoogleAdsSearchads360V23Common__PolicyViolationKey;
5813
+ }
5814
+ /**
5815
+ * Additional quota error details when there is QuotaError.
5816
+ */
5817
+ export interface Schema$GoogleAdsSearchads360V23Errors__QuotaErrorDetails {
5818
+ /**
5819
+ * The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".
5820
+ */
5821
+ rateName?: string | null;
5822
+ /**
5823
+ * The rate scope of the quota limit.
5824
+ */
5825
+ rateScope?: string | null;
5826
+ /**
5827
+ * Backoff period that customers should wait before sending next request.
5828
+ */
5829
+ retryDelay?: string | null;
5830
+ }
5831
+ /**
5832
+ * Error details returned when an resource count limit was exceeded.
5833
+ */
5834
+ export interface Schema$GoogleAdsSearchads360V23Errors__ResourceCountDetails {
5835
+ /**
5836
+ * The ID of the resource whose limit was exceeded. External customer ID if the limit is for a customer.
5837
+ */
5838
+ enclosingId?: string | null;
5839
+ /**
5840
+ * The name of the resource ( etc.) whose limit was exceeded.
5841
+ */
5842
+ enclosingResource?: string | null;
5843
+ /**
5844
+ * The count of existing entities.
5845
+ */
5846
+ existingCount?: number | null;
5847
+ /**
5848
+ * The limit which was exceeded.
5849
+ */
5850
+ limit?: number | null;
5851
+ /**
5852
+ * The resource limit type which was exceeded.
5853
+ */
5854
+ limitType?: string | null;
5855
+ }
5856
+ /**
5857
+ * Search Ads 360-specific error.
5858
+ */
5859
+ export interface Schema$GoogleAdsSearchads360V23Errors__SearchAds360Error {
5860
+ /**
5861
+ * Additional error details, which are returned by certain error codes. Most error codes do not include details.
5862
+ */
5863
+ details?: Schema$GoogleAdsSearchads360V23Errors__ErrorDetails;
5864
+ /**
5865
+ * An enum value that indicates which error occurred.
5866
+ */
5867
+ errorCode?: Schema$GoogleAdsSearchads360V23Errors__ErrorCode;
5868
+ /**
5869
+ * Describes the part of the request proto that caused the error.
5870
+ */
5871
+ location?: Schema$GoogleAdsSearchads360V23Errors__ErrorLocation;
5872
+ /**
5873
+ * A human-readable description of the error.
5874
+ */
5875
+ message?: string | null;
5876
+ /**
5877
+ * The value that triggered the error.
5878
+ */
5879
+ trigger?: Schema$GoogleAdsSearchads360V23Common__Value;
5880
+ }
5881
+ /**
5882
+ * Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.
5883
+ */
5884
+ export interface Schema$GoogleAdsSearchads360V23Errors__SearchAds360Failure {
5885
+ /**
5886
+ * The list of errors that occurred.
5887
+ */
5888
+ errors?: Schema$GoogleAdsSearchads360V23Errors__SearchAds360Error[];
5889
+ /**
5890
+ * The unique ID of the request that is used for debugging purposes.
5891
+ */
5892
+ requestId?: string | null;
5893
+ }
5894
+ /**
5895
+ * Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.
5896
+ */
5897
+ export interface Schema$GoogleAdsSearchads360V23Resources_BatchJob_BatchJobMetadata {
5898
+ /**
5899
+ * Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
5900
+ */
5901
+ completionDateTime?: string | null;
5902
+ /**
5903
+ * Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
5904
+ */
5905
+ creationDateTime?: string | null;
5906
+ /**
5907
+ * Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.
5908
+ */
5909
+ estimatedCompletionRatio?: number | null;
5910
+ /**
5911
+ * Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
5912
+ */
5913
+ executedOperationCount?: string | null;
5914
+ /**
5915
+ * Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.
5916
+ */
5917
+ executionLimitSeconds?: number | null;
5918
+ /**
5919
+ * Output only. The number of mutate operations in the batch job.
5920
+ */
5921
+ operationCount?: string | null;
5922
+ /**
5923
+ * Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
5924
+ */
5925
+ startDateTime?: string | null;
5926
+ }
5927
+ /**
5928
+ * Metadata of offline user data job.
5929
+ */
5930
+ export interface Schema$GoogleAdsSearchads360V23Resources__OfflineUserDataJobMetadata {
5931
+ /**
5932
+ * Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is "RUNNING" and final match rate when the final match rate is available after the status of the job is "SUCCESS/FAILED".
5933
+ */
5934
+ matchRateRange?: string | null;
5935
+ }
5936
+ /**
5937
+ * The metadata of the promoted experiment.
5938
+ */
5939
+ export interface Schema$GoogleAdsSearchads360V23Services__PromoteExperimentMetadata {
5940
+ /**
5941
+ * Required. The promoted experiment.
5942
+ */
5943
+ experiment?: string | null;
5944
+ }
5945
+ /**
5946
+ * The metadata of the scheduled experiment.
5947
+ */
5948
+ export interface Schema$GoogleAdsSearchads360V23Services__ScheduleExperimentMetadata {
5949
+ /**
5950
+ * Required. The scheduled experiment.
5951
+ */
5952
+ experiment?: string | null;
5953
+ }
4761
5954
 
4762
5955
  export class Resource$Customers {
4763
5956
  context: APIRequestContext;
@@ -5245,7 +6438,7 @@ export namespace searchads360_v0 {
5245
6438
  }
5246
6439
 
5247
6440
  /**
5248
- * Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
6441
+ * Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
5249
6442
  * @example
5250
6443
  * ```js
5251
6444
  * // Before running the sample: