feat(searchads360): update the API

#### searchads360:v0 The following keys were added: - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsByConversionDate.description - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsByConversionDate.format - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsByConversionDate.type - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsValueByConversionDate.description - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsValueByConversionDate.format - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.crossDeviceConversionsValueByConversionDate.type - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClickRate.description - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClickRate.format - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClickRate.type - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClicks.description - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClicks.format - schemas.GoogleAdsSearchads360V0Common__Metrics.properties.generalInvalidClicks.type - schemas.GoogleAdsSearchads360V0Resources__AdGroup.properties.effectiveLabels.description - schemas.GoogleAdsSearchads360V0Resources__AdGroup.properties.effectiveLabels.items.type - schemas.GoogleAdsSearchads360V0Resources__AdGroup.properties.effectiveLabels.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroup.properties.effectiveLabels.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.id - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.adGroup.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.adGroup.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.label.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.label.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.ownerCustomerId.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.ownerCustomerId.format - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.ownerCustomerId.readOnly - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.ownerCustomerId.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.resourceName.description - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.properties.resourceName.type - schemas.GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel.type - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.effectiveLabels.description - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.effectiveLabels.items.type - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.effectiveLabels.readOnly - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.effectiveLabels.type - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.id - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.campaign.description - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.campaign.type - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.label.description - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.label.type - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.ownerCustomerId.description - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.ownerCustomerId.format - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.ownerCustomerId.readOnly - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.ownerCustomerId.type - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.resourceName.description - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.properties.resourceName.type - schemas.GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel.type - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupEffectiveLabel.$ref - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.adGroupEffectiveLabel.description - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.campaignEffectiveLabel.$ref - schemas.GoogleAdsSearchads360V0Services__SearchAds360Row.properties.campaignEffectiveLabel.description The following keys were changed: - schemas.GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization.properties.conversionActions.description - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.biddingStrategy.description - schemas.GoogleAdsSearchads360V0Resources__Campaign.properties.campaignBudget.description
googleapis · Oct 10, 2024 · 5d3283e · 5d3283e
1 parent a68919f
commit 5d3283e
Show file tree

Hide file tree

Showing 2 changed files with 175 additions and 7 deletions.
diff --git a/discovery/searchads360-v0.json b/discovery/searchads360-v0.json
@@ -260,7 +260,7 @@
       }
     }
   },
-  "revision": "20240822",
+  "revision": "20241002",
   "rootUrl": "https://searchads360.googleapis.com/",
   "schemas": {
     "GoogleAdsSearchads360V0Common__AdScheduleInfo": {
@@ -1170,11 +1170,21 @@
           "format": "double",
           "type": "number"
         },
+        "crossDeviceConversionsByConversionDate": {
+          "description": "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.",
+          "format": "double",
+          "type": "number"
+        },
         "crossDeviceConversionsValue": {
           "description": "The sum of the value of cross-device conversions.",
           "format": "double",
           "type": "number"
         },
+        "crossDeviceConversionsValueByConversionDate": {
+          "description": "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.",
+          "format": "double",
+          "type": "number"
+        },
         "crossSellCostOfGoodsSoldMicros": {
           "description": "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",
           "format": "int64",
@@ -1200,6 +1210,16 @@
           "format": "double",
           "type": "number"
         },
+        "generalInvalidClickRate": {
+          "description": "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.",
+          "format": "double",
+          "type": "number"
+        },
+        "generalInvalidClicks": {
+          "description": "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.",
+          "format": "int64",
+          "type": "string"
+        },
         "historicalCreativeQualityScore": {
           "description": "The creative historical quality score.",
           "enum": [
@@ -3384,7 +3404,7 @@
       "id": "GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization",
       "properties": {
         "conversionActions": {
-          "description": "The selected set of conversion actions for optimizing this campaign.",
+          "description": "The selected set of resource names for conversion actions for optimizing this campaign.",
           "items": {
             "type": "string"
           },
@@ -4020,6 +4040,14 @@
           "readOnly": true,
           "type": "string"
         },
+        "effectiveLabels": {
+          "description": "Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.",
+          "items": {
+            "type": "string"
+          },
+          "readOnly": true,
+          "type": "array"
+        },
         "endDate": {
           "description": "Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14",
           "readOnly": true,
@@ -4761,6 +4789,31 @@
       },
       "type": "object"
     },
+    "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel": {
+      "description": "A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group.",
+      "id": "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel",
+      "properties": {
+        "adGroup": {
+          "description": "Immutable. The ad group to which the effective label is attached.",
+          "type": "string"
+        },
+        "label": {
+          "description": "Immutable. The effective label assigned to the ad group.",
+          "type": "string"
+        },
+        "ownerCustomerId": {
+          "description": "Output only. The ID of the Customer which owns the effective label.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "resourceName": {
+          "description": "Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}`",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleAdsSearchads360V0Resources__AdGroupLabel": {
       "description": "A relationship between an ad group and a label.",
       "id": "GoogleAdsSearchads360V0Resources__AdGroupLabel",
@@ -5651,7 +5704,7 @@
           "type": "string"
         },
         "biddingStrategy": {
-          "description": "Portfolio bidding strategy used by campaign.",
+          "description": "The resource name of the portfolio bidding strategy used by the campaign.",
           "type": "string"
         },
         "biddingStrategySystemStatus": {
@@ -5765,7 +5818,7 @@
           "type": "string"
         },
         "campaignBudget": {
-          "description": "The budget of the campaign.",
+          "description": "The resource name of the campaign budget of the campaign.",
           "type": "string"
         },
         "createTime": {
@@ -5782,6 +5835,14 @@
           "$ref": "GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting",
           "description": "The setting for controlling Dynamic Search Ads (DSA)."
         },
+        "effectiveLabels": {
+          "description": "Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.",
+          "items": {
+            "type": "string"
+          },
+          "readOnly": true,
+          "type": "array"
+        },
         "endDate": {
           "description": "The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.",
           "type": "string"
@@ -6351,6 +6412,31 @@
       },
       "type": "object"
     },
+    "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel": {
+      "description": "Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign.",
+      "id": "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel",
+      "properties": {
+        "campaign": {
+          "description": "Immutable. The campaign to which the effective label is attached.",
+          "type": "string"
+        },
+        "label": {
+          "description": "Immutable. The effective label assigned to the campaign.",
+          "type": "string"
+        },
+        "ownerCustomerId": {
+          "description": "Output only. The ID of the Customer which owns the effective label.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "resourceName": {
+          "description": "Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleAdsSearchads360V0Resources__CampaignLabel": {
       "description": "Represents a relationship between a campaign and a label.",
       "id": "GoogleAdsSearchads360V0Resources__CampaignLabel",
@@ -8339,6 +8425,10 @@
           "$ref": "GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel",
           "description": "The ad group criterion label referenced in the query."
         },
+        "adGroupEffectiveLabel": {
+          "$ref": "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel",
+          "description": "The ad group effective label referenced in the query."
+        },
         "adGroupLabel": {
           "$ref": "GoogleAdsSearchads360V0Resources__AdGroupLabel",
           "description": "The ad group label referenced in the query."
@@ -8411,6 +8501,10 @@
           "$ref": "GoogleAdsSearchads360V0Resources__CampaignCriterion",
           "description": "The campaign criterion referenced in the query."
         },
+        "campaignEffectiveLabel": {
+          "$ref": "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel",
+          "description": "The campaign effective label referenced in the query."
+        },
         "campaignLabel": {
           "$ref": "GoogleAdsSearchads360V0Resources__CampaignLabel",
           "description": "The campaign label referenced in the query."

diff --git a/src/apis/searchads360/v0.ts b/src/apis/searchads360/v0.ts
@@ -620,10 +620,18 @@ export namespace searchads360_v0 {
      * 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.
      */
     crossDeviceConversions?: number | null;
+    /**
+     * 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.
+     */
+    crossDeviceConversionsByConversionDate?: number | null;
     /**
      * The sum of the value of cross-device conversions.
      */
     crossDeviceConversionsValue?: number | null;
+    /**
+     * 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.
+     */
+    crossDeviceConversionsValueByConversionDate?: number | null;
     /**
      * 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
      */
@@ -644,6 +652,14 @@ export namespace searchads360_v0 {
      * The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
      */
     ctr?: number | null;
+    /**
+     * 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.
+     */
+    generalInvalidClickRate?: number | null;
+    /**
+     * 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.
+     */
+    generalInvalidClicks?: string | null;
     /**
      * The creative historical quality score.
      */
@@ -1824,7 +1840,7 @@ export namespace searchads360_v0 {
    */
   export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization {
     /**
-     * The selected set of conversion actions for optimizing this campaign.
+     * The selected set of resource names for conversion actions for optimizing this campaign.
      */
     conversionActions?: string[] | null;
   }
@@ -2119,6 +2135,10 @@ export namespace searchads360_v0 {
      * Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
      */
     creationTime?: string | null;
+    /**
+     * Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.
+     */
+    effectiveLabels?: string[] | null;
     /**
      * Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14
      */
@@ -2428,6 +2448,27 @@ export namespace searchads360_v0 {
      */
     resourceName?: string | null;
   }
+  /**
+   * A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group.
+   */
+  export interface Schema$GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel {
+    /**
+     * Immutable. The ad group to which the effective label is attached.
+     */
+    adGroup?: string | null;
+    /**
+     * Immutable. The effective label assigned to the ad group.
+     */
+    label?: string | null;
+    /**
+     * Output only. The ID of the Customer which owns the effective label.
+     */
+    ownerCustomerId?: string | null;
+    /**
+     * Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id\}/adGroupEffectiveLabels/{ad_group_id\}~{label_id\}`
+     */
+    resourceName?: string | null;
+  }
   /**
    * A relationship between an ad group and a label.
    */
@@ -2838,7 +2879,7 @@ export namespace searchads360_v0 {
      */
     advertisingChannelType?: string | null;
     /**
-     * Portfolio bidding strategy used by campaign.
+     * The resource name of the portfolio bidding strategy used by the campaign.
      */
     biddingStrategy?: string | null;
     /**
@@ -2850,7 +2891,7 @@ export namespace searchads360_v0 {
      */
     biddingStrategyType?: string | null;
     /**
-     * The budget of the campaign.
+     * The resource name of the campaign budget of the campaign.
      */
     campaignBudget?: string | null;
     /**
@@ -2865,6 +2906,10 @@ export namespace searchads360_v0 {
      * The setting for controlling Dynamic Search Ads (DSA).
      */
     dynamicSearchAdsSetting?: Schema$GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting;
+    /**
+     * Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
+     */
+    effectiveLabels?: string[] | null;
     /**
      * The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
      */
@@ -3147,6 +3192,27 @@ export namespace searchads360_v0 {
      */
     webpage?: Schema$GoogleAdsSearchads360V0Common__WebpageInfo;
   }
+  /**
+   * Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign.
+   */
+  export interface Schema$GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel {
+    /**
+     * Immutable. The campaign to which the effective label is attached.
+     */
+    campaign?: string | null;
+    /**
+     * Immutable. The effective label assigned to the campaign.
+     */
+    label?: string | null;
+    /**
+     * Output only. The ID of the Customer which owns the effective label.
+     */
+    ownerCustomerId?: string | null;
+    /**
+     * Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id\}/campaignEffectiveLabels/{campaign_id\}~{label_id\}`
+     */
+    resourceName?: string | null;
+  }
   /**
    * Represents a relationship between a campaign and a label.
    */
@@ -4183,6 +4249,10 @@ export namespace searchads360_v0 {
      * The ad group criterion label referenced in the query.
      */
     adGroupCriterionLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel;
+    /**
+     * The ad group effective label referenced in the query.
+     */
+    adGroupEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel;
     /**
      * The ad group label referenced in the query.
      */
@@ -4255,6 +4325,10 @@ export namespace searchads360_v0 {
      * The campaign criterion referenced in the query.
      */
     campaignCriterion?: Schema$GoogleAdsSearchads360V0Resources__CampaignCriterion;
+    /**
+     * The campaign effective label referenced in the query.
+     */
+    campaignEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel;
     /**
      * The campaign label referenced in the query.
      */