@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/build/v0.d.ts CHANGED
@@ -403,15 +403,15 @@ export declare namespace searchads360_v0 {
403
403
  */
404
404
  allConversions?: number | null;
405
405
  /**
406
- * 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.
406
+ * 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).
407
407
  */
408
408
  allConversionsByConversionDate?: number | null;
409
409
  /**
410
- * 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.
410
+ * 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.
411
411
  */
412
412
  allConversionsFromClickToCall?: number | null;
413
413
  /**
414
- * 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.
414
+ * 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.
415
415
  */
416
416
  allConversionsFromDirections?: number | null;
417
417
  /**
@@ -423,23 +423,23 @@ export declare namespace searchads360_v0 {
423
423
  */
424
424
  allConversionsFromInteractionsValuePerInteraction?: number | null;
425
425
  /**
426
- * 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.
426
+ * 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.
427
427
  */
428
428
  allConversionsFromMenu?: number | null;
429
429
  /**
430
- * The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
430
+ * The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.
431
431
  */
432
432
  allConversionsFromOrder?: number | null;
433
433
  /**
434
- * 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.
434
+ * 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.
435
435
  */
436
436
  allConversionsFromOtherEngagement?: number | null;
437
437
  /**
438
- * Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
438
+ * Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.
439
439
  */
440
440
  allConversionsFromStoreVisit?: number | null;
441
441
  /**
442
- * The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
442
+ * The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.
443
443
  */
444
444
  allConversionsFromStoreWebsite?: number | null;
445
445
  /**
@@ -447,7 +447,7 @@ export declare namespace searchads360_v0 {
447
447
  */
448
448
  allConversionsValue?: number | null;
449
449
  /**
450
- * 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.
450
+ * 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).
451
451
  */
452
452
  allConversionsValueByConversionDate?: number | null;
453
453
  /**
@@ -463,11 +463,11 @@ export declare namespace searchads360_v0 {
463
463
  */
464
464
  averageCost?: number | null;
465
465
  /**
466
- * 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
466
+ * 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).
467
467
  */
468
468
  averageCpc?: number | null;
469
469
  /**
470
- * 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
470
+ * 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).
471
471
  */
472
472
  averageCpm?: number | null;
473
473
  /**
@@ -487,23 +487,23 @@ export declare namespace searchads360_v0 {
487
487
  */
488
488
  clicks?: string | null;
489
489
  /**
490
- * 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.
490
+ * 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.
491
491
  */
492
492
  clientAccountConversions?: number | null;
493
493
  /**
494
- * 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.
494
+ * 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.
495
495
  */
496
496
  clientAccountConversionsValue?: number | null;
497
497
  /**
498
- * 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
498
+ * 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).
499
499
  */
500
500
  clientAccountCrossSellCostOfGoodsSoldMicros?: string | null;
501
501
  /**
502
- * 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
502
+ * 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).
503
503
  */
504
504
  clientAccountCrossSellGrossProfitMicros?: string | null;
505
505
  /**
506
- * 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
506
+ * 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).
507
507
  */
508
508
  clientAccountCrossSellRevenueMicros?: string | null;
509
509
  /**
@@ -511,15 +511,15 @@ export declare namespace searchads360_v0 {
511
511
  */
512
512
  clientAccountCrossSellUnitsSold?: number | null;
513
513
  /**
514
- * 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
514
+ * 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).
515
515
  */
516
516
  clientAccountLeadCostOfGoodsSoldMicros?: string | null;
517
517
  /**
518
- * 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
518
+ * 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).
519
519
  */
520
520
  clientAccountLeadGrossProfitMicros?: string | null;
521
521
  /**
522
- * 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
522
+ * 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).
523
523
  */
524
524
  clientAccountLeadRevenueMicros?: string | null;
525
525
  /**
@@ -551,7 +551,7 @@ export declare namespace searchads360_v0 {
551
551
  */
552
552
  conversions?: number | null;
553
553
  /**
554
- * 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.
554
+ * 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.
555
555
  */
556
556
  conversionsByConversionDate?: number | null;
557
557
  /**
@@ -559,7 +559,7 @@ export declare namespace searchads360_v0 {
559
559
  */
560
560
  conversionsFromInteractionsRate?: number | null;
561
561
  /**
562
- * 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.
562
+ * 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.
563
563
  */
564
564
  conversionsFromInteractionsValuePerInteraction?: number | null;
565
565
  /**
@@ -575,7 +575,7 @@ export declare namespace searchads360_v0 {
575
575
  */
576
576
  conversionsValuePerCost?: number | null;
577
577
  /**
578
- * 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
578
+ * 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.
579
579
  */
580
580
  costMicros?: string | null;
581
581
  /**
@@ -591,15 +591,15 @@ export declare namespace searchads360_v0 {
591
591
  */
592
592
  costPerConversion?: number | null;
593
593
  /**
594
- * 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.
594
+ * 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.
595
595
  */
596
596
  costPerCurrentModelAttributedConversion?: number | null;
597
597
  /**
598
- * 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.
598
+ * 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`.
599
599
  */
600
600
  crossDeviceConversions?: number | null;
601
601
  /**
602
- * 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.
602
+ * 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)
603
603
  */
604
604
  crossDeviceConversionsByConversionDate?: number | null;
605
605
  /**
@@ -607,19 +607,19 @@ export declare namespace searchads360_v0 {
607
607
  */
608
608
  crossDeviceConversionsValue?: number | null;
609
609
  /**
610
- * 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.
610
+ * 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)
611
611
  */
612
612
  crossDeviceConversionsValueByConversionDate?: number | null;
613
613
  /**
614
- * 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
614
+ * 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).
615
615
  */
616
616
  crossSellCostOfGoodsSoldMicros?: string | null;
617
617
  /**
618
- * 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
618
+ * 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).
619
619
  */
620
620
  crossSellGrossProfitMicros?: string | null;
621
621
  /**
622
- * 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
622
+ * 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).
623
623
  */
624
624
  crossSellRevenueMicros?: string | null;
625
625
  /**
@@ -631,11 +631,11 @@ export declare namespace searchads360_v0 {
631
631
  */
632
632
  ctr?: number | null;
633
633
  /**
634
- * 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.
634
+ * 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).
635
635
  */
636
636
  generalInvalidClickRate?: number | null;
637
637
  /**
638
- * 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.
638
+ * 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).
639
639
  */
640
640
  generalInvalidClicks?: string | null;
641
641
  /**
@@ -687,15 +687,15 @@ export declare namespace searchads360_v0 {
687
687
  */
688
688
  invalidClicks?: string | null;
689
689
  /**
690
- * 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
690
+ * 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).
691
691
  */
692
692
  leadCostOfGoodsSoldMicros?: string | null;
693
693
  /**
694
- * 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
694
+ * 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).
695
695
  */
696
696
  leadGrossProfitMicros?: string | null;
697
697
  /**
698
- * 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
698
+ * 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).
699
699
  */
700
700
  leadRevenueMicros?: string | null;
701
701
  /**
@@ -719,7 +719,7 @@ export declare namespace searchads360_v0 {
719
719
  */
720
720
  revenueMicros?: string | null;
721
721
  /**
722
- * 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.
722
+ * 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.
723
723
  */
724
724
  searchAbsoluteTopImpressionShare?: number | null;
725
725
  /**
@@ -731,7 +731,7 @@ export declare namespace searchads360_v0 {
731
731
  */
732
732
  searchBudgetLostImpressionShare?: number | null;
733
733
  /**
734
- * 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.
734
+ * 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.
735
735
  */
736
736
  searchBudgetLostTopImpressionShare?: number | null;
737
737
  /**
@@ -779,7 +779,7 @@ export declare namespace searchads360_v0 {
779
779
  */
780
780
  valuePerAllConversions?: number | null;
781
781
  /**
782
- * 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.
782
+ * 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).
783
783
  */
784
784
  valuePerAllConversionsByConversionDate?: number | null;
785
785
  /**
@@ -848,7 +848,7 @@ export declare namespace searchads360_v0 {
848
848
  description2?: string | null;
849
849
  }
850
850
  /**
851
- * A Search Ads 360 expanded text ad.
851
+ * A Search Ads 360 expanded text ad. Expanded text ads are deprecated. Use SearchAds360ResponsiveSearchAd instead.
852
852
  */
853
853
  export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo {
854
854
  /**
@@ -947,6 +947,10 @@ export declare namespace searchads360_v0 {
947
947
  * Segment only fields.
948
948
  */
949
949
  export interface Schema$GoogleAdsSearchads360V0Common__Segments {
950
+ /**
951
+ * Ad Format type.
952
+ */
953
+ adFormatType?: string | null;
950
954
  /**
951
955
  * Ad network type.
952
956
  */
@@ -1195,6 +1199,42 @@ export declare namespace searchads360_v0 {
1195
1199
  * The raw event conversion dimensions.
1196
1200
  */
1197
1201
  rawEventConversionDimensions?: Schema$GoogleAdsSearchads360V0Common__Value[];
1202
+ /**
1203
+ * The display names of participants in an event listing, like performers, speakers, or teams.
1204
+ */
1205
+ verticalAdsEventParticipantDisplayNames?: string | null;
1206
+ /**
1207
+ * The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.
1208
+ */
1209
+ verticalAdsHotelClass?: string | null;
1210
+ /**
1211
+ * The listing associated with a listing impression, click or conversion.
1212
+ */
1213
+ verticalAdsListing?: string | null;
1214
+ /**
1215
+ * 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.
1216
+ */
1217
+ verticalAdsListingBrand?: string | null;
1218
+ /**
1219
+ * The city where the vertical ads listing is located.
1220
+ */
1221
+ verticalAdsListingCity?: string | null;
1222
+ /**
1223
+ * The country where the vertical ads listing is located.
1224
+ */
1225
+ verticalAdsListingCountry?: string | null;
1226
+ /**
1227
+ * The region where the vertical ads listing is located.
1228
+ */
1229
+ verticalAdsListingRegion?: string | null;
1230
+ /**
1231
+ * A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.
1232
+ */
1233
+ verticalAdsPartnerAccount?: string | null;
1234
+ /**
1235
+ * Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.
1236
+ */
1237
+ verticalAdsVertical?: string | null;
1198
1238
  /**
1199
1239
  * Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
1200
1240
  */
@@ -1204,6 +1244,32 @@ export declare namespace searchads360_v0 {
1204
1244
  */
1205
1245
  year?: number | null;
1206
1246
  }
1247
+ /**
1248
+ * Represents an attestation about synthetic content from a single source.
1249
+ */
1250
+ export interface Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation {
1251
+ /**
1252
+ * The source of the synthetic content attestation.
1253
+ */
1254
+ source?: string | null;
1255
+ /**
1256
+ * Indicates whether the content is considered synthetic by this source.
1257
+ */
1258
+ status?: string | null;
1259
+ }
1260
+ /**
1261
+ * Container for synthetic content attestations from different sources, such as the advertiser and Google systems.
1262
+ */
1263
+ export interface Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo {
1264
+ /**
1265
+ * Input provided by the advertiser.
1266
+ */
1267
+ advertiserAttestation?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation;
1268
+ /**
1269
+ * Output only. Information about synthetic content generated by Google's systems.
1270
+ */
1271
+ systemAttestation?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentAttestation;
1272
+ }
1207
1273
  /**
1208
1274
  * An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
1209
1275
  */
@@ -1830,11 +1896,11 @@ export declare namespace searchads360_v0 {
1830
1896
  */
1831
1897
  targetGoogleSearch?: boolean | null;
1832
1898
  /**
1833
- * Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
1899
+ * 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.
1834
1900
  */
1835
1901
  targetPartnerSearchNetwork?: boolean | null;
1836
1902
  /**
1837
- * Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
1903
+ * Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
1838
1904
  */
1839
1905
  targetSearchNetwork?: boolean | null;
1840
1906
  }
@@ -2095,7 +2161,7 @@ export declare namespace searchads360_v0 {
2095
2161
  */
2096
2162
  expandedDynamicSearchAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo;
2097
2163
  /**
2098
- * Immutable. Details pertaining to an expanded text ad.
2164
+ * Immutable. Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `SearchAds360ResponsiveSearchAd` instead.
2099
2165
  */
2100
2166
  expandedTextAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo;
2101
2167
  /**
@@ -2134,6 +2200,10 @@ export declare namespace searchads360_v0 {
2134
2200
  * Immutable. Details pertaining to a responsive search ad.
2135
2201
  */
2136
2202
  responsiveSearchAd?: Schema$GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo;
2203
+ /**
2204
+ * 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`
2205
+ */
2206
+ syntheticContentInfo?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo;
2137
2207
  /**
2138
2208
  * Immutable. Details pertaining to a text ad.
2139
2209
  */
@@ -2156,7 +2226,7 @@ export declare namespace searchads360_v0 {
2156
2226
  */
2157
2227
  adRotationMode?: string | null;
2158
2228
  /**
2159
- * The maximum CPC (cost-per-click) bid.
2229
+ * 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.
2160
2230
  */
2161
2231
  cpcBidMicros?: string | null;
2162
2232
  /**
@@ -2585,7 +2655,7 @@ export declare namespace searchads360_v0 {
2585
2655
  resourceName?: string | null;
2586
2656
  }
2587
2657
  /**
2588
- * An age range view.
2658
+ * 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.
2589
2659
  */
2590
2660
  export interface Schema$GoogleAdsSearchads360V0Resources__AgeRangeView {
2591
2661
  /**
@@ -2669,6 +2739,10 @@ export declare namespace searchads360_v0 {
2669
2739
  * Output only. The status of the asset.
2670
2740
  */
2671
2741
  status?: string | null;
2742
+ /**
2743
+ * 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`
2744
+ */
2745
+ syntheticContentInfo?: Schema$GoogleAdsSearchads360V0Common__SyntheticContentInfo;
2672
2746
  /**
2673
2747
  * Output only. A text asset.
2674
2748
  */
@@ -3213,7 +3287,7 @@ export declare namespace searchads360_v0 {
3213
3287
  */
3214
3288
  export interface Schema$GoogleAdsSearchads360V0Resources__CampaignBudget {
3215
3289
  /**
3216
- * 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.
3290
+ * 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.
3217
3291
  */
3218
3292
  amountMicros?: string | null;
3219
3293
  /**
@@ -3345,7 +3419,7 @@ export declare namespace searchads360_v0 {
3345
3419
  resourceName?: string | null;
3346
3420
  }
3347
3421
  /**
3348
- * Cart data sales view.
3422
+ * 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.
3349
3423
  */
3350
3424
  export interface Schema$GoogleAdsSearchads360V0Resources__CartDataSalesView {
3351
3425
  /**
@@ -3894,7 +3968,7 @@ export declare namespace searchads360_v0 {
3894
3968
  resourceName?: string | null;
3895
3969
  }
3896
3970
  /**
3897
- * 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.
3971
+ * 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.
3898
3972
  */
3899
3973
  export interface Schema$GoogleAdsSearchads360V0Resources__GenderView {
3900
3974
  /**
@@ -4166,7 +4240,7 @@ export declare namespace searchads360_v0 {
4166
4240
  resourceName?: string | null;
4167
4241
  }
4168
4242
  /**
4169
- * A user list. This is a list of users a customer may target.
4243
+ * 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`.
4170
4244
  */
4171
4245
  export interface Schema$GoogleAdsSearchads360V0Resources__UserList {
4172
4246
  /**
@@ -4174,7 +4248,7 @@ export declare namespace searchads360_v0 {
4174
4248
  */
4175
4249
  id?: string | null;
4176
4250
  /**
4177
- * Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
4251
+ * 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`.
4178
4252
  */
4179
4253
  name?: string | null;
4180
4254
  /**
@@ -4709,6 +4783,1126 @@ export declare namespace searchads360_v0 {
4709
4783
  */
4710
4784
  totalResultsCount?: string | null;
4711
4785
  }
4786
+ /**
4787
+ * Indicates that a resource's ability to serve in a particular country is constrained.
4788
+ */
4789
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint {
4790
+ /**
4791
+ * Geo target constant resource name of the country in which serving is constrained.
4792
+ */
4793
+ countryCriterion?: string | null;
4794
+ }
4795
+ /**
4796
+ * A list of countries where a resource's serving is constrained.
4797
+ */
4798
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList {
4799
+ /**
4800
+ * Countries in which serving is restricted.
4801
+ */
4802
+ countries?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint[];
4803
+ /**
4804
+ * Total number of countries targeted by the resource.
4805
+ */
4806
+ totalTargetedCountries?: number | null;
4807
+ }
4808
+ /**
4809
+ * Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.
4810
+ */
4811
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint {
4812
+ }
4813
+ /**
4814
+ * Evidence of mismatches between the URLs of a resource.
4815
+ */
4816
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch {
4817
+ /**
4818
+ * The set of URLs that did not match each other.
4819
+ */
4820
+ urlTypes?: string[] | null;
4821
+ }
4822
+ /**
4823
+ * Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
4824
+ */
4825
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking {
4826
+ /**
4827
+ * The type of device that failed to load the URL.
4828
+ */
4829
+ device?: string | null;
4830
+ /**
4831
+ * The type of DNS error.
4832
+ */
4833
+ dnsErrorType?: string | null;
4834
+ /**
4835
+ * The full URL that didn't work.
4836
+ */
4837
+ expandedUrl?: string | null;
4838
+ /**
4839
+ * The HTTP error code.
4840
+ */
4841
+ httpErrorCode?: string | null;
4842
+ /**
4843
+ * 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"
4844
+ */
4845
+ lastCheckedDateTime?: string | null;
4846
+ }
4847
+ /**
4848
+ * A list of strings found in a destination page that caused a policy finding.
4849
+ */
4850
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList {
4851
+ /**
4852
+ * List of text found in the resource's destination page.
4853
+ */
4854
+ destinationTexts?: string[] | null;
4855
+ }
4856
+ /**
4857
+ * A list of fragments of text that violated a policy.
4858
+ */
4859
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList {
4860
+ /**
4861
+ * The fragments of text from the resource that caused the policy finding.
4862
+ */
4863
+ texts?: string[] | null;
4864
+ }
4865
+ /**
4866
+ * 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.
4867
+ */
4868
+ export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList {
4869
+ /**
4870
+ * Websites that caused the policy finding.
4871
+ */
4872
+ websites?: string[] | null;
4873
+ }
4874
+ /**
4875
+ * Describes the effect on serving that a policy topic entry will have.
4876
+ */
4877
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicConstraint {
4878
+ /**
4879
+ * Countries where the resource's domain is not covered by the certificates associated with it.
4880
+ */
4881
+ certificateDomainMismatchInCountryList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4882
+ /**
4883
+ * Countries where a certificate is required for serving.
4884
+ */
4885
+ certificateMissingInCountryList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4886
+ /**
4887
+ * Countries where the resource cannot serve.
4888
+ */
4889
+ countryConstraintList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList;
4890
+ /**
4891
+ * Reseller constraint.
4892
+ */
4893
+ resellerConstraint?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint;
4894
+ }
4895
+ /**
4896
+ * 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.
4897
+ */
4898
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicEntry {
4899
+ /**
4900
+ * Indicates how serving of this resource may be affected (for example, not serving in a country).
4901
+ */
4902
+ constraints?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicConstraint[];
4903
+ /**
4904
+ * Additional information that explains policy finding (for example, the brand name for a trademark finding).
4905
+ */
4906
+ evidences?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicEvidence[];
4907
+ /**
4908
+ * 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.
4909
+ */
4910
+ topic?: string | null;
4911
+ /**
4912
+ * Describes the negative or positive effect this policy will have on serving.
4913
+ */
4914
+ type?: string | null;
4915
+ }
4916
+ /**
4917
+ * Additional information that explains a policy finding.
4918
+ */
4919
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyTopicEvidence {
4920
+ /**
4921
+ * Mismatch between the destinations of a resource's URLs.
4922
+ */
4923
+ destinationMismatch?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch;
4924
+ /**
4925
+ * Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
4926
+ */
4927
+ destinationNotWorking?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking;
4928
+ /**
4929
+ * The text in the destination of the resource that is causing a policy finding.
4930
+ */
4931
+ destinationTextList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList;
4932
+ /**
4933
+ * The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
4934
+ */
4935
+ languageCode?: string | null;
4936
+ /**
4937
+ * List of evidence found in the text of a resource.
4938
+ */
4939
+ textList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList;
4940
+ /**
4941
+ * List of websites linked with this resource.
4942
+ */
4943
+ websiteList?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList;
4944
+ }
4945
+ /**
4946
+ * Key of the violation. The key is used for referring to a violation when filing an exemption request.
4947
+ */
4948
+ export interface Schema$GoogleAdsSearchads360V23Common__PolicyViolationKey {
4949
+ /**
4950
+ * Unique ID of the violated policy.
4951
+ */
4952
+ policyName?: string | null;
4953
+ /**
4954
+ * 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.
4955
+ */
4956
+ violatingText?: string | null;
4957
+ }
4958
+ /**
4959
+ * A generic data container.
4960
+ */
4961
+ export interface Schema$GoogleAdsSearchads360V23Common__Value {
4962
+ /**
4963
+ * A boolean.
4964
+ */
4965
+ booleanValue?: boolean | null;
4966
+ /**
4967
+ * A double.
4968
+ */
4969
+ doubleValue?: number | null;
4970
+ /**
4971
+ * A float.
4972
+ */
4973
+ floatValue?: number | null;
4974
+ /**
4975
+ * An int64.
4976
+ */
4977
+ int64Value?: string | null;
4978
+ /**
4979
+ * A string.
4980
+ */
4981
+ stringValue?: string | null;
4982
+ }
4983
+ /**
4984
+ * A part of a field path.
4985
+ */
4986
+ export interface Schema$GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement {
4987
+ /**
4988
+ * The name of a field or a oneof
4989
+ */
4990
+ fieldName?: string | null;
4991
+ /**
4992
+ * If field_name is a repeated field, this is the element that failed
4993
+ */
4994
+ index?: number | null;
4995
+ }
4996
+ /**
4997
+ * Error details for a budget below per-day minimum error.
4998
+ */
4999
+ export interface Schema$GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails {
5000
+ /**
5001
+ * The minimum budget required by the campaign per day, in micros of the advertiser currency. Applies to both daily and custom budgets.
5002
+ */
5003
+ budgetPerDayMinimumMicros?: string | null;
5004
+ /**
5005
+ * The advertiser's currency, represented as a three-letter ISO 4217 currency code (such as "USD").
5006
+ */
5007
+ currencyCode?: string | null;
5008
+ /**
5009
+ * 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.
5010
+ */
5011
+ failedBudgetAmountMicros?: string | null;
5012
+ /**
5013
+ * 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.
5014
+ */
5015
+ failedBudgetTotalAmountMicros?: string | null;
5016
+ /**
5017
+ * 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.
5018
+ */
5019
+ minimumBudgetAmountMicros?: string | null;
5020
+ /**
5021
+ * 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.
5022
+ */
5023
+ minimumBudgetTotalAmountMicros?: string | null;
5024
+ }
5025
+ /**
5026
+ * The error reason represented by type and enum.
5027
+ */
5028
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorCode {
5029
+ /**
5030
+ * The reasons for the access invitation error
5031
+ */
5032
+ accessInvitationError?: string | null;
5033
+ /**
5034
+ * The reasons for account budget proposal errors.
5035
+ */
5036
+ accountBudgetProposalError?: string | null;
5037
+ /**
5038
+ * The reasons for the account link status change error
5039
+ */
5040
+ accountLinkError?: string | null;
5041
+ /**
5042
+ * The reasons for the ad customizer error
5043
+ */
5044
+ adCustomizerError?: string | null;
5045
+ /**
5046
+ * An error with an Ad Group Ad mutate.
5047
+ */
5048
+ adError?: string | null;
5049
+ /**
5050
+ * The reasons for the ad group ad error
5051
+ */
5052
+ adGroupAdError?: string | null;
5053
+ /**
5054
+ * The reasons for the ad group bid modifier error
5055
+ */
5056
+ adGroupBidModifierError?: string | null;
5057
+ /**
5058
+ * The reasons for the ad group criterion customizer error.
5059
+ */
5060
+ adGroupCriterionCustomizerError?: string | null;
5061
+ /**
5062
+ * Indicates failure to properly authenticate user.
5063
+ */
5064
+ adGroupCriterionError?: string | null;
5065
+ /**
5066
+ * The reasons for the ad group customizer error.
5067
+ */
5068
+ adGroupCustomizerError?: string | null;
5069
+ /**
5070
+ * An error with an Ad Group mutate.
5071
+ */
5072
+ adGroupError?: string | null;
5073
+ /**
5074
+ * The reasons for the ad group feed error
5075
+ */
5076
+ adGroupFeedError?: string | null;
5077
+ /**
5078
+ * The reasons for the ad parameter error
5079
+ */
5080
+ adParameterError?: string | null;
5081
+ /**
5082
+ * The reasons for the ad sharing error
5083
+ */
5084
+ adSharingError?: string | null;
5085
+ /**
5086
+ * The reasons for the adx error
5087
+ */
5088
+ adxError?: string | null;
5089
+ /**
5090
+ * The reasons for the asset error
5091
+ */
5092
+ assetError?: string | null;
5093
+ /**
5094
+ * The reasons for the GenAI asset generation error.
5095
+ */
5096
+ assetGenerationError?: string | null;
5097
+ /**
5098
+ * The reasons for the asset group asset error
5099
+ */
5100
+ assetGroupAssetError?: string | null;
5101
+ /**
5102
+ * The reasons for the asset group error
5103
+ */
5104
+ assetGroupError?: string | null;
5105
+ /**
5106
+ * The reasons for the asset group listing group filter error
5107
+ */
5108
+ assetGroupListingGroupFilterError?: string | null;
5109
+ /**
5110
+ * The reasons for the asset group hint error
5111
+ */
5112
+ assetGroupSignalError?: string | null;
5113
+ /**
5114
+ * The reasons for the asset link error
5115
+ */
5116
+ assetLinkError?: string | null;
5117
+ /**
5118
+ * The reasons for the asset set asset error
5119
+ */
5120
+ assetSetAssetError?: string | null;
5121
+ /**
5122
+ * The reasons for the asset set error
5123
+ */
5124
+ assetSetError?: string | null;
5125
+ /**
5126
+ * The reasons for the asset set link error
5127
+ */
5128
+ assetSetLinkError?: string | null;
5129
+ /**
5130
+ * The reasons for the audience error
5131
+ */
5132
+ audienceError?: string | null;
5133
+ /**
5134
+ * The reasons for the Audience Insights error
5135
+ */
5136
+ audienceInsightsError?: string | null;
5137
+ /**
5138
+ * Indicates failure to properly authenticate user.
5139
+ */
5140
+ authenticationError?: string | null;
5141
+ /**
5142
+ * An error encountered when trying to authorize a user.
5143
+ */
5144
+ authorizationError?: string | null;
5145
+ /**
5146
+ * The reasons for error in automatically created asset removal action.
5147
+ */
5148
+ automaticallyCreatedAssetRemovalError?: string | null;
5149
+ /**
5150
+ * The reasons for the batch job error
5151
+ */
5152
+ batchJobError?: string | null;
5153
+ /**
5154
+ * The reasons for the Benchmarks error.
5155
+ */
5156
+ benchmarksError?: string | null;
5157
+ /**
5158
+ * The reasons for the bidding errors
5159
+ */
5160
+ biddingError?: string | null;
5161
+ /**
5162
+ * An error with a Bidding Strategy mutate.
5163
+ */
5164
+ biddingStrategyError?: string | null;
5165
+ /**
5166
+ * The reasons for the billing setup error
5167
+ */
5168
+ billingSetupError?: string | null;
5169
+ /**
5170
+ * The reasons for the brand guidelines migration error.
5171
+ */
5172
+ brandGuidelinesMigrationError?: string | null;
5173
+ /**
5174
+ * An error with a Campaign Budget mutate.
5175
+ */
5176
+ campaignBudgetError?: string | null;
5177
+ /**
5178
+ * The reasons for the campaign conversion goal error
5179
+ */
5180
+ campaignConversionGoalError?: string | null;
5181
+ /**
5182
+ * The reasons for the campaign criterion error
5183
+ */
5184
+ campaignCriterionError?: string | null;
5185
+ /**
5186
+ * The reasons for the campaign customizer error.
5187
+ */
5188
+ campaignCustomizerError?: string | null;
5189
+ /**
5190
+ * The reasons for the campaign draft error
5191
+ */
5192
+ campaignDraftError?: string | null;
5193
+ /**
5194
+ * An error with a Campaign mutate.
5195
+ */
5196
+ campaignError?: string | null;
5197
+ /**
5198
+ * The reasons for the campaign experiment error
5199
+ */
5200
+ campaignExperimentError?: string | null;
5201
+ /**
5202
+ * The reasons for the campaign feed error
5203
+ */
5204
+ campaignFeedError?: string | null;
5205
+ /**
5206
+ * The reasons for the campaign goal config error.
5207
+ */
5208
+ campaignGoalConfigError?: string | null;
5209
+ /**
5210
+ * The reasons for the campaign lifecycle goal error
5211
+ */
5212
+ campaignLifecycleGoalError?: string | null;
5213
+ /**
5214
+ * The reasons for the campaign shared set error
5215
+ */
5216
+ campaignSharedSetError?: string | null;
5217
+ /**
5218
+ * The reasons for the change event error
5219
+ */
5220
+ changeEventError?: string | null;
5221
+ /**
5222
+ * The reasons for the change status error
5223
+ */
5224
+ changeStatusError?: string | null;
5225
+ /**
5226
+ * The reasons for the click view error
5227
+ */
5228
+ clickViewError?: string | null;
5229
+ /**
5230
+ * The reasons for the collection size error
5231
+ */
5232
+ collectionSizeError?: string | null;
5233
+ /**
5234
+ * The reasons for the context error
5235
+ */
5236
+ contextError?: string | null;
5237
+ /**
5238
+ * The reasons for the conversion action error
5239
+ */
5240
+ conversionActionError?: string | null;
5241
+ /**
5242
+ * The reasons for the conversion adjustment upload error
5243
+ */
5244
+ conversionAdjustmentUploadError?: string | null;
5245
+ /**
5246
+ * The reasons for the conversion custom variable error
5247
+ */
5248
+ conversionCustomVariableError?: string | null;
5249
+ /**
5250
+ * The reasons for the conversion goal campaign config error
5251
+ */
5252
+ conversionGoalCampaignConfigError?: string | null;
5253
+ /**
5254
+ * The reasons for the conversion upload error
5255
+ */
5256
+ conversionUploadError?: string | null;
5257
+ /**
5258
+ * The reasons for the conversion value rule error
5259
+ */
5260
+ conversionValueRuleError?: string | null;
5261
+ /**
5262
+ * The reasons for the conversion value rule set error
5263
+ */
5264
+ conversionValueRuleSetError?: string | null;
5265
+ /**
5266
+ * The reasons for the country code error
5267
+ */
5268
+ countryCodeError?: string | null;
5269
+ /**
5270
+ * The reasons for the criterion error
5271
+ */
5272
+ criterionError?: string | null;
5273
+ /**
5274
+ * The reasons for the currency code error
5275
+ */
5276
+ currencyCodeError?: string | null;
5277
+ /**
5278
+ * The reasons for the currency errors.
5279
+ */
5280
+ currencyError?: string | null;
5281
+ /**
5282
+ * The reasons for the custom audience error
5283
+ */
5284
+ customAudienceError?: string | null;
5285
+ /**
5286
+ * The reasons for the custom column error
5287
+ */
5288
+ customColumnError?: string | null;
5289
+ /**
5290
+ * The reasons for the custom conversion goal error
5291
+ */
5292
+ customConversionGoalError?: string | null;
5293
+ /**
5294
+ * The reasons for the customer client link error
5295
+ */
5296
+ customerClientLinkError?: string | null;
5297
+ /**
5298
+ * The reasons for the customer customizer error.
5299
+ */
5300
+ customerCustomizerError?: string | null;
5301
+ /**
5302
+ * The reasons for the customer error
5303
+ */
5304
+ customerError?: string | null;
5305
+ /**
5306
+ * The reasons for the customer feed error
5307
+ */
5308
+ customerFeedError?: string | null;
5309
+ /**
5310
+ * The reasons for the customer lifecycle goal error
5311
+ */
5312
+ customerLifecycleGoalError?: string | null;
5313
+ /**
5314
+ * The reasons for the customer manager link error
5315
+ */
5316
+ customerManagerLinkError?: string | null;
5317
+ /**
5318
+ * The reasons for the customer SK Ad network conversion value schema error
5319
+ */
5320
+ customerSkAdNetworkConversionValueSchemaError?: string | null;
5321
+ /**
5322
+ * The reasons for the customer user access mutate error
5323
+ */
5324
+ customerUserAccessError?: string | null;
5325
+ /**
5326
+ * The reasons for the custom interest error
5327
+ */
5328
+ customInterestError?: string | null;
5329
+ /**
5330
+ * The reasons for the customizer attribute error.
5331
+ */
5332
+ customizerAttributeError?: string | null;
5333
+ /**
5334
+ * The reasons for the database error.
5335
+ */
5336
+ databaseError?: string | null;
5337
+ /**
5338
+ * The reasons for the data link error
5339
+ */
5340
+ dataLinkError?: string | null;
5341
+ /**
5342
+ * The reasons for the date error
5343
+ */
5344
+ dateError?: string | null;
5345
+ /**
5346
+ * The reasons for the date range error
5347
+ */
5348
+ dateRangeError?: string | null;
5349
+ /**
5350
+ * The reasons for the distinct error
5351
+ */
5352
+ distinctError?: string | null;
5353
+ /**
5354
+ * The reason for enum error.
5355
+ */
5356
+ enumError?: string | null;
5357
+ /**
5358
+ * The reasons for the experiment arm error
5359
+ */
5360
+ experimentArmError?: string | null;
5361
+ /**
5362
+ * The reasons for the experiment error
5363
+ */
5364
+ experimentError?: string | null;
5365
+ /**
5366
+ * The reasons for the extension feed item error
5367
+ */
5368
+ extensionFeedItemError?: string | null;
5369
+ /**
5370
+ * The reasons for the extension setting error
5371
+ */
5372
+ extensionSettingError?: string | null;
5373
+ /**
5374
+ * The reasons for the feed attribute reference error
5375
+ */
5376
+ feedAttributeReferenceError?: string | null;
5377
+ /**
5378
+ * The reasons for the feed error
5379
+ */
5380
+ feedError?: string | null;
5381
+ /**
5382
+ * The reasons for the feed item error
5383
+ */
5384
+ feedItemError?: string | null;
5385
+ /**
5386
+ * The reasons for the feed item set error
5387
+ */
5388
+ feedItemSetError?: string | null;
5389
+ /**
5390
+ * The reasons for the feed item set link error
5391
+ */
5392
+ feedItemSetLinkError?: string | null;
5393
+ /**
5394
+ * The reasons for the feed item target error
5395
+ */
5396
+ feedItemTargetError?: string | null;
5397
+ /**
5398
+ * The reasons for the feed item validation error
5399
+ */
5400
+ feedItemValidationError?: string | null;
5401
+ /**
5402
+ * The reasons for the feed mapping error
5403
+ */
5404
+ feedMappingError?: string | null;
5405
+ /**
5406
+ * The reasons for the field error
5407
+ */
5408
+ fieldError?: string | null;
5409
+ /**
5410
+ * An error with a field mask
5411
+ */
5412
+ fieldMaskError?: string | null;
5413
+ /**
5414
+ * The reasons for the final url expansion asset view error
5415
+ */
5416
+ finalUrlExpansionAssetViewError?: string | null;
5417
+ /**
5418
+ * The reasons for the function error
5419
+ */
5420
+ functionError?: string | null;
5421
+ /**
5422
+ * The reasons for the function parsing error
5423
+ */
5424
+ functionParsingError?: string | null;
5425
+ /**
5426
+ * The reasons for the geo target constant suggestion error.
5427
+ */
5428
+ geoTargetConstantSuggestionError?: string | null;
5429
+ /**
5430
+ * The reasons for the goal error.
5431
+ */
5432
+ goalError?: string | null;
5433
+ /**
5434
+ * The reasons for the header error.
5435
+ */
5436
+ headerError?: string | null;
5437
+ /**
5438
+ * The reasons for an identity verification error.
5439
+ */
5440
+ identityVerificationError?: string | null;
5441
+ /**
5442
+ * The reasons for the id error
5443
+ */
5444
+ idError?: string | null;
5445
+ /**
5446
+ * The reasons for the image error
5447
+ */
5448
+ imageError?: string | null;
5449
+ /**
5450
+ * The reasons for the incentive error
5451
+ */
5452
+ incentiveError?: string | null;
5453
+ /**
5454
+ * An unexpected server-side error.
5455
+ */
5456
+ internalError?: string | null;
5457
+ /**
5458
+ * The reasons for invalid parameter errors.
5459
+ */
5460
+ invalidParameterError?: string | null;
5461
+ /**
5462
+ * The reasons for the invoice error
5463
+ */
5464
+ invoiceError?: string | null;
5465
+ /**
5466
+ * The reason for keyword plan ad group error.
5467
+ */
5468
+ keywordPlanAdGroupError?: string | null;
5469
+ /**
5470
+ * The reason for keyword plan ad group keyword error.
5471
+ */
5472
+ keywordPlanAdGroupKeywordError?: string | null;
5473
+ /**
5474
+ * The reason for keyword plan campaign error.
5475
+ */
5476
+ keywordPlanCampaignError?: string | null;
5477
+ /**
5478
+ * The reason for keyword plan campaign keyword error.
5479
+ */
5480
+ keywordPlanCampaignKeywordError?: string | null;
5481
+ /**
5482
+ * The reason for keyword plan error.
5483
+ */
5484
+ keywordPlanError?: string | null;
5485
+ /**
5486
+ * The reason for keyword idea error.
5487
+ */
5488
+ keywordPlanIdeaError?: string | null;
5489
+ /**
5490
+ * The reason for the label error.
5491
+ */
5492
+ labelError?: string | null;
5493
+ /**
5494
+ * The reasons for the language code error
5495
+ */
5496
+ languageCodeError?: string | null;
5497
+ /**
5498
+ * An error with a list operation.
5499
+ */
5500
+ listOperationError?: string | null;
5501
+ /**
5502
+ * The reasons for the manager link error
5503
+ */
5504
+ managerLinkError?: string | null;
5505
+ /**
5506
+ * The reasons for the media bundle error
5507
+ */
5508
+ mediaBundleError?: string | null;
5509
+ /**
5510
+ * The reasons for the media file error
5511
+ */
5512
+ mediaFileError?: string | null;
5513
+ /**
5514
+ * The reasons for media uploading errors.
5515
+ */
5516
+ mediaUploadError?: string | null;
5517
+ /**
5518
+ * Container for enum describing possible merchant center errors.
5519
+ */
5520
+ merchantCenterError?: string | null;
5521
+ /**
5522
+ * The reasons for the multiplier error
5523
+ */
5524
+ multiplierError?: string | null;
5525
+ /**
5526
+ * An error with a mutate
5527
+ */
5528
+ mutateError?: string | null;
5529
+ /**
5530
+ * The reasons for the new resource creation error
5531
+ */
5532
+ newResourceCreationError?: string | null;
5533
+ /**
5534
+ * The reasons for the not allowlisted error
5535
+ */
5536
+ notAllowlistedError?: string | null;
5537
+ /**
5538
+ * The reasons for the not empty error
5539
+ */
5540
+ notEmptyError?: string | null;
5541
+ /**
5542
+ * The reasons for the null error
5543
+ */
5544
+ nullError?: string | null;
5545
+ /**
5546
+ * The reasons for the offline user data job error.
5547
+ */
5548
+ offlineUserDataJobError?: string | null;
5549
+ /**
5550
+ * The reasons for the operation access denied error
5551
+ */
5552
+ operationAccessDeniedError?: string | null;
5553
+ /**
5554
+ * The reasons for the operator error
5555
+ */
5556
+ operatorError?: string | null;
5557
+ /**
5558
+ * The reasons for the mutate job error
5559
+ */
5560
+ partialFailureError?: string | null;
5561
+ /**
5562
+ * The reasons for errors in payments accounts service
5563
+ */
5564
+ paymentsAccountError?: string | null;
5565
+ /**
5566
+ * The reasons for the policy finding error.
5567
+ */
5568
+ policyFindingError?: string | null;
5569
+ /**
5570
+ * The reasons for the policy validation parameter error
5571
+ */
5572
+ policyValidationParameterError?: string | null;
5573
+ /**
5574
+ * The reasons for the policy violation error
5575
+ */
5576
+ policyViolationError?: string | null;
5577
+ /**
5578
+ * The reasons for the product link error
5579
+ */
5580
+ productLinkError?: string | null;
5581
+ /**
5582
+ * The reasons for the product link invitation error
5583
+ */
5584
+ productLinkInvitationError?: string | null;
5585
+ /**
5586
+ * An error with the query
5587
+ */
5588
+ queryError?: string | null;
5589
+ /**
5590
+ * An error with the amount of quota remaining.
5591
+ */
5592
+ quotaError?: string | null;
5593
+ /**
5594
+ * The reasons for the range error
5595
+ */
5596
+ rangeError?: string | null;
5597
+ /**
5598
+ * The reasons for the reach plan error
5599
+ */
5600
+ reachPlanError?: string | null;
5601
+ /**
5602
+ * The reasons for error in applying a recommendation
5603
+ */
5604
+ recommendationError?: string | null;
5605
+ /**
5606
+ * The reasons for the recommendation subscription error.
5607
+ */
5608
+ recommendationSubscriptionError?: string | null;
5609
+ /**
5610
+ * The reasons for the region code error
5611
+ */
5612
+ regionCodeError?: string | null;
5613
+ /**
5614
+ * An error caused by the request
5615
+ */
5616
+ requestError?: string | null;
5617
+ /**
5618
+ * The reasons for the resource access denied error
5619
+ */
5620
+ resourceAccessDeniedError?: string | null;
5621
+ /**
5622
+ * The reasons for the resource count limit exceeded error
5623
+ */
5624
+ resourceCountLimitExceededError?: string | null;
5625
+ /**
5626
+ * The reasons for the Search term insight error
5627
+ */
5628
+ searchTermInsightError?: string | null;
5629
+ /**
5630
+ * The reasons for the setting error
5631
+ */
5632
+ settingError?: string | null;
5633
+ /**
5634
+ * The reasons for the shareable preview error.
5635
+ */
5636
+ shareablePreviewError?: string | null;
5637
+ /**
5638
+ * The reasons for the shared criterion error
5639
+ */
5640
+ sharedCriterionError?: string | null;
5641
+ /**
5642
+ * The reasons for the shared set error
5643
+ */
5644
+ sharedSetError?: string | null;
5645
+ /**
5646
+ * The reasons for error in querying shopping product.
5647
+ */
5648
+ shoppingProductError?: string | null;
5649
+ /**
5650
+ * The reasons for the size limit error
5651
+ */
5652
+ sizeLimitError?: string | null;
5653
+ /**
5654
+ * The reasons for the Smart campaign error
5655
+ */
5656
+ smartCampaignError?: string | null;
5657
+ /**
5658
+ * The reasons for the string format error
5659
+ */
5660
+ stringFormatError?: string | null;
5661
+ /**
5662
+ * The reasons for the string length error
5663
+ */
5664
+ stringLengthError?: string | null;
5665
+ /**
5666
+ * The reasons for the third party app analytics link mutate error
5667
+ */
5668
+ thirdPartyAppAnalyticsLinkError?: string | null;
5669
+ /**
5670
+ * The reasons for the time zone error
5671
+ */
5672
+ timeZoneError?: string | null;
5673
+ /**
5674
+ * An error with a URL field mutate.
5675
+ */
5676
+ urlFieldError?: string | null;
5677
+ /**
5678
+ * The reasons for the user data error.
5679
+ */
5680
+ userDataError?: string | null;
5681
+ /**
5682
+ * The reasons for a user list customer type error.
5683
+ */
5684
+ userListCustomerTypeError?: string | null;
5685
+ /**
5686
+ * The reasons for the user list error
5687
+ */
5688
+ userListError?: string | null;
5689
+ /**
5690
+ * An error with a Video Campaign mutate.
5691
+ */
5692
+ videoCampaignError?: string | null;
5693
+ /**
5694
+ * The reasons for YouTube video registration errors.
5695
+ */
5696
+ youtubeVideoRegistrationError?: string | null;
5697
+ }
5698
+ /**
5699
+ * Additional error details.
5700
+ */
5701
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorDetails {
5702
+ /**
5703
+ * Details for a budget below per-day minimum error.
5704
+ */
5705
+ budgetPerDayMinimumErrorDetails?: Schema$GoogleAdsSearchads360V23Errors__BudgetPerDayMinimumErrorDetails;
5706
+ /**
5707
+ * Describes policy violation findings.
5708
+ */
5709
+ policyFindingDetails?: Schema$GoogleAdsSearchads360V23Errors__PolicyFindingDetails;
5710
+ /**
5711
+ * Describes an ad policy violation.
5712
+ */
5713
+ policyViolationDetails?: Schema$GoogleAdsSearchads360V23Errors__PolicyViolationDetails;
5714
+ /**
5715
+ * Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.
5716
+ */
5717
+ quotaErrorDetails?: Schema$GoogleAdsSearchads360V23Errors__QuotaErrorDetails;
5718
+ /**
5719
+ * Details for a resource count limit exceeded error.
5720
+ */
5721
+ resourceCountDetails?: Schema$GoogleAdsSearchads360V23Errors__ResourceCountDetails;
5722
+ /**
5723
+ * 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.
5724
+ */
5725
+ unpublishedErrorCode?: string | null;
5726
+ }
5727
+ /**
5728
+ * Describes the part of the request proto that caused the error.
5729
+ */
5730
+ export interface Schema$GoogleAdsSearchads360V23Errors__ErrorLocation {
5731
+ /**
5732
+ * A field path that indicates which field was invalid in the request.
5733
+ */
5734
+ fieldPathElements?: Schema$GoogleAdsSearchads360V23Errors_ErrorLocation_FieldPathElement[];
5735
+ }
5736
+ /**
5737
+ * Error returned as part of a mutate response. This error indicates one or more policy findings in the fields of a resource.
5738
+ */
5739
+ export interface Schema$GoogleAdsSearchads360V23Errors__PolicyFindingDetails {
5740
+ /**
5741
+ * 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).
5742
+ */
5743
+ policyTopicEntries?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicEntry[];
5744
+ }
5745
+ /**
5746
+ * Error returned as part of a mutate response. This error indicates single policy violation by some text in one of the fields.
5747
+ */
5748
+ export interface Schema$GoogleAdsSearchads360V23Errors__PolicyViolationDetails {
5749
+ /**
5750
+ * Human readable description of policy violation.
5751
+ */
5752
+ externalPolicyDescription?: string | null;
5753
+ /**
5754
+ * Human readable name of the policy.
5755
+ */
5756
+ externalPolicyName?: string | null;
5757
+ /**
5758
+ * Whether user can file an exemption request for this violation.
5759
+ */
5760
+ isExemptible?: boolean | null;
5761
+ /**
5762
+ * Unique identifier for this violation. If policy is exemptible, this key may be used to request exemption.
5763
+ */
5764
+ key?: Schema$GoogleAdsSearchads360V23Common__PolicyViolationKey;
5765
+ }
5766
+ /**
5767
+ * Additional quota error details when there is QuotaError.
5768
+ */
5769
+ export interface Schema$GoogleAdsSearchads360V23Errors__QuotaErrorDetails {
5770
+ /**
5771
+ * The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".
5772
+ */
5773
+ rateName?: string | null;
5774
+ /**
5775
+ * The rate scope of the quota limit.
5776
+ */
5777
+ rateScope?: string | null;
5778
+ /**
5779
+ * Backoff period that customers should wait before sending next request.
5780
+ */
5781
+ retryDelay?: string | null;
5782
+ }
5783
+ /**
5784
+ * Error details returned when an resource count limit was exceeded.
5785
+ */
5786
+ export interface Schema$GoogleAdsSearchads360V23Errors__ResourceCountDetails {
5787
+ /**
5788
+ * The ID of the resource whose limit was exceeded. External customer ID if the limit is for a customer.
5789
+ */
5790
+ enclosingId?: string | null;
5791
+ /**
5792
+ * The name of the resource ( etc.) whose limit was exceeded.
5793
+ */
5794
+ enclosingResource?: string | null;
5795
+ /**
5796
+ * The count of existing entities.
5797
+ */
5798
+ existingCount?: number | null;
5799
+ /**
5800
+ * The limit which was exceeded.
5801
+ */
5802
+ limit?: number | null;
5803
+ /**
5804
+ * The resource limit type which was exceeded.
5805
+ */
5806
+ limitType?: string | null;
5807
+ }
5808
+ /**
5809
+ * Search Ads 360-specific error.
5810
+ */
5811
+ export interface Schema$GoogleAdsSearchads360V23Errors__SearchAds360Error {
5812
+ /**
5813
+ * Additional error details, which are returned by certain error codes. Most error codes do not include details.
5814
+ */
5815
+ details?: Schema$GoogleAdsSearchads360V23Errors__ErrorDetails;
5816
+ /**
5817
+ * An enum value that indicates which error occurred.
5818
+ */
5819
+ errorCode?: Schema$GoogleAdsSearchads360V23Errors__ErrorCode;
5820
+ /**
5821
+ * Describes the part of the request proto that caused the error.
5822
+ */
5823
+ location?: Schema$GoogleAdsSearchads360V23Errors__ErrorLocation;
5824
+ /**
5825
+ * A human-readable description of the error.
5826
+ */
5827
+ message?: string | null;
5828
+ /**
5829
+ * The value that triggered the error.
5830
+ */
5831
+ trigger?: Schema$GoogleAdsSearchads360V23Common__Value;
5832
+ }
5833
+ /**
5834
+ * Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.
5835
+ */
5836
+ export interface Schema$GoogleAdsSearchads360V23Errors__SearchAds360Failure {
5837
+ /**
5838
+ * The list of errors that occurred.
5839
+ */
5840
+ errors?: Schema$GoogleAdsSearchads360V23Errors__SearchAds360Error[];
5841
+ /**
5842
+ * The unique ID of the request that is used for debugging purposes.
5843
+ */
5844
+ requestId?: string | null;
5845
+ }
5846
+ /**
5847
+ * Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.
5848
+ */
5849
+ export interface Schema$GoogleAdsSearchads360V23Resources_BatchJob_BatchJobMetadata {
5850
+ /**
5851
+ * 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"
5852
+ */
5853
+ completionDateTime?: string | null;
5854
+ /**
5855
+ * 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"
5856
+ */
5857
+ creationDateTime?: string | null;
5858
+ /**
5859
+ * 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.
5860
+ */
5861
+ estimatedCompletionRatio?: number | null;
5862
+ /**
5863
+ * Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
5864
+ */
5865
+ executedOperationCount?: string | null;
5866
+ /**
5867
+ * 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.
5868
+ */
5869
+ executionLimitSeconds?: number | null;
5870
+ /**
5871
+ * Output only. The number of mutate operations in the batch job.
5872
+ */
5873
+ operationCount?: string | null;
5874
+ /**
5875
+ * 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"
5876
+ */
5877
+ startDateTime?: string | null;
5878
+ }
5879
+ /**
5880
+ * Metadata of offline user data job.
5881
+ */
5882
+ export interface Schema$GoogleAdsSearchads360V23Resources__OfflineUserDataJobMetadata {
5883
+ /**
5884
+ * 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".
5885
+ */
5886
+ matchRateRange?: string | null;
5887
+ }
5888
+ /**
5889
+ * The metadata of the promoted experiment.
5890
+ */
5891
+ export interface Schema$GoogleAdsSearchads360V23Services__PromoteExperimentMetadata {
5892
+ /**
5893
+ * Required. The promoted experiment.
5894
+ */
5895
+ experiment?: string | null;
5896
+ }
5897
+ /**
5898
+ * The metadata of the scheduled experiment.
5899
+ */
5900
+ export interface Schema$GoogleAdsSearchads360V23Services__ScheduleExperimentMetadata {
5901
+ /**
5902
+ * Required. The scheduled experiment.
5903
+ */
5904
+ experiment?: string | null;
5905
+ }
4712
5906
  export class Resource$Customers {
4713
5907
  context: APIRequestContext;
4714
5908
  customColumns: Resource$Customers$Customcolumns;
@@ -4923,7 +6117,7 @@ export declare namespace searchads360_v0 {
4923
6117
  context: APIRequestContext;
4924
6118
  constructor(context: APIRequestContext);
4925
6119
  /**
4926
- * Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
6120
+ * Returns all rows that match the search query. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ChangeEventError]() [ChangeStatusError]() [ClickViewError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
4927
6121
  * @example
4928
6122
  * ```js
4929
6123
  * // Before running the sample: