Search Ads 360 Reporting API . customers

close()

Close httplib2 connections.

createCustomerClient(customerId, body=None, x__xgafv=None)

Creates a new client under manager. The new client customer is returned. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()

Args:
  customerId: string, Required. The ID of the Manager under whom client customer is being created. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CustomerService.CreateCustomerClient.
  "accessRole": "A String", # The proposed role of user on the created client customer. Accessible only to customers on the allow-list.
  "customerClient": { # A customer. # Required. The new client customer to create. The resource name on this customer will be ignored.
    "accountLevel": "A String", # Output only. The account level of the customer: Manager, Sub-manager, Associate manager, Service account.
    "accountStatus": "A String", # Output only. Account status, for example, Enabled, Paused, Removed, etc.
    "accountType": "A String", # Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.
    "associateManagerDescriptiveName": "A String", # Output only. The descriptive name of the associate manager.
    "associateManagerId": "A String", # Output only. The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.
    "autoTaggingEnabled": True or False, # Whether auto-tagging is enabled for the customer.
    "callReportingSetting": { # Call reporting setting for a customer. # Call reporting setting for a customer.
      "callConversionAction": "A String", # Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
      "callConversionReportingEnabled": True or False, # Whether to enable call conversion reporting.
      "callReportingEnabled": True or False, # Enable reporting of phone call events by redirecting them through Google System.
    },
    "containsEuPoliticalAdvertising": "A String", # Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update the self-declaration status of individual campaigns.
    "conversionTrackingSetting": { # A collection of customer-wide settings related to Search Ads 360 Conversion Tracking. # Conversion tracking setting for a customer.
      "acceptedCustomerDataTerms": True or False, # Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
      "conversionTrackingId": "A String", # Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
      "conversionTrackingStatus": "A String", # Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
      "crossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.
      "enhancedConversionsForLeadsEnabled": True or False, # Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
      "googleAdsConversionCustomer": "A String", # The resource name of the customer where conversions are created and managed. This field is read-only.
      "googleAdsCrossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
    },
    "creationTime": "A String", # Output only. The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
    "currencyCode": "A String", # Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
    "customerAgreementSetting": { # Customer Agreement Setting for a customer. # Output only. Customer Agreement Setting for a customer.
      "acceptedLeadFormTerms": True or False, # Output only. Whether the customer has accepted lead form term of service.
    },
    "descriptiveName": "A String", # Optional, non-unique descriptive name of the customer.
    "doubleClickCampaignManagerSetting": { # DoubleClick Campaign Manager (DCM) setting for a manager customer. # Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer.
      "advertiserId": "A String", # Output only. ID of the Campaign Manager advertiser associated with this customer.
      "networkId": "A String", # Output only. ID of the Campaign Manager network associated with this customer.
      "timeZone": "A String", # Output only. Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.
    },
    "engineId": "A String", # Output only. ID of the account in the external engine account.
    "finalUrlSuffix": "A String", # The URL template for appending params to the final URL.
    "hasPartnersBadge": True or False, # Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
    "id": "A String", # Output only. The ID of the customer.
    "imageAssetAutoMigrationDone": True or False, # Output only. True if feed based image has been migrated to asset based image.
    "imageAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
    "lastModifiedTime": "A String", # Output only. The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
    "localServicesSettings": { # Settings for Local Services customer. # Output only. Settings for Local Services customer.
      "granularInsuranceStatuses": [ # Output only. A read-only list of geo vertical level insurance statuses.
        { # Insurance status at geo + vertical level.
          "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
          "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
          "verificationStatus": "A String", # Output only. Granular insurance status, per geo + vertical.
        },
      ],
      "granularLicenseStatuses": [ # Output only. A read-only list of geo vertical level license statuses.
        { # License status at geo + vertical level.
          "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
          "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
          "verificationStatus": "A String", # Output only. Granular license status, per geo + vertical.
        },
      ],
    },
    "locationAssetAutoMigrationDone": True or False, # Output only. True if feed based location has been migrated to asset based location.
    "locationAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
    "manager": True or False, # Output only. Whether the customer is a manager.
    "managerDescriptiveName": "A String", # Output only. The descriptive name of the manager.
    "managerId": "A String", # Output only. The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.
    "optimizationScore": 3.14, # Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
    "optimizationScoreWeight": 3.14, # Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
    "payPerConversionEligibilityFailureReasons": [ # Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
      "A String",
    ],
    "remarketingSetting": { # Remarketing setting for a customer. # Output only. Remarketing setting for a customer.
      "googleGlobalSiteTag": "A String", # Output only. The Google tag.
    },
    "resourceName": "A String", # Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
    "status": "A String", # Output only. The status of the customer.
    "subManagerDescriptiveName": "A String", # Output only. The descriptive name of the sub manager.
    "subManagerId": "A String", # Output only. The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.
    "testAccount": True or False, # Output only. Whether the customer is a test account.
    "timeZone": "A String", # Immutable. The local timezone ID of the customer.
    "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL out of parameters.
    "videoBrandSafetySuitability": "A String", # Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
    "videoCustomer": { # Video specific information about a Customer. # Video specific information about a Customer.
      "thirdPartyIntegrationPartners": { # Container for Customer level third party integration partners. # Third Party integration partners.
        "brandLiftIntegrationPartners": [ # Allowed third party integration partners for Brand Lift verification.
          { # Container for third party Brand Lift integration data for Customer.
            "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
            "brandLiftIntegrationPartner": "A String", # Allowed Third Party integration partners for Brand Lift verification.
          },
        ],
        "brandSafetyIntegrationPartners": [ # Allowed third party integration partners for brand safety verification.
          { # Container for third party brand safety integration data for Customer.
            "brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
          },
        ],
        "reachIntegrationPartners": [ # Allowed third party integration partners for reach verification.
          { # Container for third party reach integration data for Customer.
            "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
            "reachIntegrationPartner": "A String", # Allowed Third Party integration partners for reach verification.
          },
        ],
        "viewabilityIntegrationPartners": [ # Allowed third party integration partners for YouTube viewability verification.
          { # Container for third party viewability integration data for Customer.
            "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
            "viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
          },
        ],
      },
    },
  },
  "emailAddress": "A String", # Email address of the user who should be invited on the created client customer. Accessible only to customers on the allow-list.
  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for CreateCustomerClient mutate.
  "invitationLink": "A String", # Link for inviting user to access the created customer. Accessible to allowlisted customers only.
  "resourceName": "A String", # The resource name of the newly created customer. Customer resource names have the form: `customers/{customer_id}`.
}

generateAdGroupThemes(customerId, body=None, x__xgafv=None)

Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for KeywordPlanIdeaService.GenerateAdGroupThemes.
  "adGroups": [ # Required. A list of resource names of AdGroups to group keywords into. Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
    "A String",
  ],
  "keywords": [ # Required. A list of keywords to group into the provided AdGroups.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KeywordPlanIdeaService.GenerateAdGroupThemes.
  "adGroupKeywordSuggestions": [ # A list of suggested AdGroup/keyword pairings.
    { # The suggested text and AdGroup/Campaign pairing for a given keyword.
      "keywordText": "A String", # The original keyword text.
      "suggestedAdGroup": "A String", # The suggested AdGroup for the keyword. Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
      "suggestedCampaign": "A String", # The suggested Campaign for the keyword. Resource name format: `customers/{customer_id}/campaigns/{campaign_id}`
      "suggestedKeywordText": "A String", # The normalized version of keyword_text for BROAD/EXACT/PHRASE suggestions.
      "suggestedMatchType": "A String", # The suggested keyword match type.
    },
  ],
  "unusableAdGroups": [ # A list of provided AdGroups that could not be used as suggestions.
    { # An AdGroup/Campaign pair that could not be used as a suggestion for keywords. AdGroups may not be usable if the AdGroup * belongs to a Campaign that is not ENABLED or PAUSED * is itself not ENABLED
      "adGroup": "A String", # The AdGroup resource name. Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
      "campaign": "A String", # The Campaign resource name. Resource name format: `customers/{customer_id}/campaigns/{campaign_id}`
    },
  ],
}

generateAudienceCompositionInsights(customerId, body=None, x__xgafv=None)

Returns a collection of attributes that are represented in an audience of interest, with metrics that compare each attribute's share of the audience with its share of a baseline audience. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateAudienceCompositionInsights.
  "audience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # Required. The audience of interest for which insights are being requested.
    "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
      { # An age range criterion.
        "type": "A String", # Type of the age range.
      },
    ],
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
      "type": "A String", # Type of the gender.
    },
    "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
      { # An income range criterion.
        "type": "A String", # Type of the income range.
      },
    ],
    "lineups": [ # Lineups representing the YouTube content viewed by the audience.
      { # A YouTube Lineup.
        "lineupId": "A String", # Required. The numeric ID of the lineup.
      },
    ],
    "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
      "type": "A String", # Type of the parental status.
    },
    "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
      { # A list of AudienceInsightsAttributes.
        "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
          { # An audience attribute that can be used to request insights about the audience.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
        ],
      },
    ],
    "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
      "userList": "A String", # The User List resource name.
    },
  },
  "baselineAudience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # The baseline audience to which the audience of interest is being compared.
    "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
      { # An age range criterion.
        "type": "A String", # Type of the age range.
      },
    ],
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
      "type": "A String", # Type of the gender.
    },
    "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
      { # An income range criterion.
        "type": "A String", # Type of the income range.
      },
    ],
    "lineups": [ # Lineups representing the YouTube content viewed by the audience.
      { # A YouTube Lineup.
        "lineupId": "A String", # Required. The numeric ID of the lineup.
      },
    ],
    "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
      "type": "A String", # Type of the parental status.
    },
    "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
      { # A list of AudienceInsightsAttributes.
        "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
          { # An audience attribute that can be used to request insights about the audience.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
        ],
      },
    ],
    "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
      "userList": "A String", # The User List resource name.
    },
  },
  "customerInsightsGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "dataMonth": "A String", # The one-month range of historical data to use for insights, in the format "yyyy-mm". If unset, insights will be returned for the last thirty days of data.
  "dimensions": [ # Required. The audience dimensions for which composition insights should be returned. Supported dimensions are KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_CHANNEL, YOUTUBE_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, .
    "A String",
  ],
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.GenerateAudienceCompositionInsights.
  "sections": [ # The contents of the insights report, organized into sections. Each section is associated with one of the AudienceInsightsDimension values in the request. There may be more than one section per dimension.
    { # A collection of related attributes of the same type in an audience composition insights report.
      "clusteredAttributes": [ # Additional attributes for this audience, grouped into clusters. Only populated if dimension is YOUTUBE_CHANNEL.
        { # A collection of related attributes, with metadata and metrics, in an audience composition insights report.
          "attributes": [ # The individual attributes that make up this cluster, with metadata and metrics.
            { # An audience attribute with metadata and metrics.
              "attributeMetadata": { # An audience attribute, with metadata about it, returned in response to a search. # The attribute with its metadata.
                "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
                  "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                    "type": "A String", # Type of the age range.
                  },
                  "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                    "categoryId": "A String", # Required. The criterion ID of the category.
                  },
                  "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                    "type": "A String", # Type of the device.
                  },
                  "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                    "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
                  },
                  "gender": { # A gender criterion. # An audience attribute defined by a gender.
                    "type": "A String", # Type of the gender.
                  },
                  "incomeRange": { # An income range criterion. # A household income percentile range.
                    "type": "A String", # Type of the income range.
                  },
                  "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                    "lineupId": "A String", # Required. The numeric ID of the lineup.
                  },
                  "location": { # A location criterion. # An audience attribute defined by a geographic location.
                    "geoTargetConstant": "A String", # The geo target constant resource name.
                  },
                  "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                    "type": "A String", # Type of the parental status.
                  },
                  "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                    "userInterestCategory": "A String", # The UserInterest resource name.
                  },
                  "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                    "userList": "A String", # The User List resource name.
                  },
                  "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                  },
                  "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
                  },
                },
                "dimension": "A String", # The type of the attribute.
                "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
                "displayName": "A String", # The human-readable name of the attribute.
                "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
                  "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
                    "A String",
                  ],
                  "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
                    # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
                  ],
                },
                "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
                  "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
                  "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
                  "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
                    "geoTargetConstant": "A String", # The geo target constant resource name.
                  },
                  "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
                  "sampleChannels": [ # Examples of channels that are included in the lineup.
                    { # A YouTube channel returned as an example of the content in a lineup.
                      "displayName": "A String", # The name of the sample channel.
                      "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                      },
                      "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                        "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                      },
                    },
                  ],
                },
                "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
                  "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
                    "geoTargetConstant": "A String", # The geo target constant resource name.
                  },
                },
                "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
                "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
                "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
                  "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
                },
                "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
                  "userListType": "A String", # The user list type.
                },
                "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
                "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
                  "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                },
                "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
                  "commentsCount": "A String", # The total number of comments.
                  "likesCount": "A String", # The total number of likes.
                  "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
                  "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
                  "videoProperties": [ # The properties of this video (such as shorts, live stream).
                    "A String",
                  ],
                  "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
                  "viewsCount": "A String", # The total number of views.
                },
              },
              "metrics": { # The share and index metrics associated with an attribute in an audience composition insights report. # Share and index metrics for the attribute.
                "audienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the specific audience that match the attribute.
                "baselineAudienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the baseline audience that match the attribute.
                "index": 3.14, # The ratio of audience_share to baseline_audience_share, or zero if this ratio is undefined or is not meaningful.
                "score": 3.14, # A relevance score from 0 to 1 inclusive.
              },
            },
          ],
          "clusterDisplayName": "A String", # The name of this cluster of attributes
          "clusterMetrics": { # The share and index metrics associated with an attribute in an audience composition insights report. # If the dimension associated with this cluster is YOUTUBE_CHANNEL, then cluster_metrics are metrics associated with the cluster as a whole. For other dimensions, this field is unset.
            "audienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the specific audience that match the attribute.
            "baselineAudienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the baseline audience that match the attribute.
            "index": 3.14, # The ratio of audience_share to baseline_audience_share, or zero if this ratio is undefined or is not meaningful.
            "score": 3.14, # A relevance score from 0 to 1 inclusive.
          },
        },
      ],
      "dimension": "A String", # The type of the attributes in this section.
      "topAttributes": [ # The most relevant segments for this audience. If dimension is GENDER, AGE_RANGE or PARENTAL_STATUS, then this list of attributes is exhaustive.
        { # An audience attribute with metadata and metrics.
          "attributeMetadata": { # An audience attribute, with metadata about it, returned in response to a search. # The attribute with its metadata.
            "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
              "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                "type": "A String", # Type of the age range.
              },
              "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                "categoryId": "A String", # Required. The criterion ID of the category.
              },
              "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                "type": "A String", # Type of the device.
              },
              "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
              },
              "gender": { # A gender criterion. # An audience attribute defined by a gender.
                "type": "A String", # Type of the gender.
              },
              "incomeRange": { # An income range criterion. # A household income percentile range.
                "type": "A String", # Type of the income range.
              },
              "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                "lineupId": "A String", # Required. The numeric ID of the lineup.
              },
              "location": { # A location criterion. # An audience attribute defined by a geographic location.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                "type": "A String", # Type of the parental status.
              },
              "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                "userInterestCategory": "A String", # The UserInterest resource name.
              },
              "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                "userList": "A String", # The User List resource name.
              },
              "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
              },
              "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
              },
            },
            "dimension": "A String", # The type of the attribute.
            "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
            "displayName": "A String", # The human-readable name of the attribute.
            "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
              "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
                "A String",
              ],
              "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
                # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
              ],
            },
            "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
              "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
              "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
              "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
              "sampleChannels": [ # Examples of channels that are included in the lineup.
                { # A YouTube channel returned as an example of the content in a lineup.
                  "displayName": "A String", # The name of the sample channel.
                  "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                  },
                  "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                    "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                  },
                },
              ],
            },
            "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
              "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
            },
            "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
            "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
            "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
              "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
            },
            "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
              "userListType": "A String", # The user list type.
            },
            "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
            "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
              "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
            },
            "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
              "commentsCount": "A String", # The total number of comments.
              "likesCount": "A String", # The total number of likes.
              "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
              "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
              "videoProperties": [ # The properties of this video (such as shorts, live stream).
                "A String",
              ],
              "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
              "viewsCount": "A String", # The total number of views.
            },
          },
          "metrics": { # The share and index metrics associated with an attribute in an audience composition insights report. # Share and index metrics for the attribute.
            "audienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the specific audience that match the attribute.
            "baselineAudienceShare": 3.14, # The fraction (from 0 to 1 inclusive) of the baseline audience that match the attribute.
            "index": 3.14, # The ratio of audience_share to baseline_audience_share, or zero if this ratio is undefined or is not meaningful.
            "score": 3.14, # A relevance score from 0 to 1 inclusive.
          },
        },
      ],
    },
  ],
}

generateAudienceDefinition(customerId, body=None, x__xgafv=None)

Returns a collection of audience attributes using generative AI based on the provided audience description. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateAudienceDefinition.
  "audienceDescription": { # A text description of the audience of interest for which insights are being requested in AudienceInsightsService. # Required. Provide a text description of an audience to get AI-generated structured suggestions. This can take around 5 or more seconds to complete Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH. Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST, CATEGORY and KNOWLEDGE_GRAPH.
    "audienceDescription": "A String", # Required. An English language text description of an audience to get suggestions for. Maximum length is 2000 characters. For example, "Women in their 30s who love to travel".
    "audienceDimensions": { # A collection of dimensions to be used for generating insights. # Optional. An optional list of audience dimensions to return.
      "dimensions": [ # Required. A list of dimensions.
        "A String",
      ],
    },
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "marketingObjective": "A String", # Optional. An optional marketing objective which will influence the type of suggestions produced.
  },
  "customerInsightsGroup": "A String", # Optional. The name of the customer being planned for. This is a user-defined value.
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.GenerateAudienceDefinition.
  "highRelevanceAttributes": [ # The attributes that make up the audience definition.
    { # An audience attribute, with metadata about it, returned in response to a search.
      "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
        "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
          "type": "A String", # Type of the age range.
        },
        "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
          "categoryId": "A String", # Required. The criterion ID of the category.
        },
        "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
          "type": "A String", # Type of the device.
        },
        "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
          "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
        },
        "gender": { # A gender criterion. # An audience attribute defined by a gender.
          "type": "A String", # Type of the gender.
        },
        "incomeRange": { # An income range criterion. # A household income percentile range.
          "type": "A String", # Type of the income range.
        },
        "lineup": { # A YouTube Lineup. # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
        "location": { # A location criterion. # An audience attribute defined by a geographic location.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
          "type": "A String", # Type of the parental status.
        },
        "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
          "userInterestCategory": "A String", # The UserInterest resource name.
        },
        "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
          "userList": "A String", # The User List resource name.
        },
        "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
          "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
        },
        "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
          "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
        },
      },
      "dimension": "A String", # The type of the attribute.
      "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
      "displayName": "A String", # The human-readable name of the attribute.
      "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
        "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
          "A String",
        ],
        "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
          # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
        ],
      },
      "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
        "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
        "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
        "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
        "sampleChannels": [ # Examples of channels that are included in the lineup.
          { # A YouTube channel returned as an example of the content in a lineup.
            "displayName": "A String", # The name of the sample channel.
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
              "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
            },
          },
        ],
      },
      "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
        "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      },
      "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
      "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
        "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
      },
      "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
        "userListType": "A String", # The user list type.
      },
      "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
        "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
      },
      "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
        "commentsCount": "A String", # The total number of comments.
        "likesCount": "A String", # The total number of likes.
        "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
        "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
        "videoProperties": [ # The properties of this video (such as shorts, live stream).
          "A String",
        ],
        "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
        "viewsCount": "A String", # The total number of views.
      },
    },
  ],
  "mediumRelevanceAttributes": [ # Additional attributes that are less relevant but still related to the audience description. Use these attributes to broaden the audience definition to reach more users.
    { # An audience attribute, with metadata about it, returned in response to a search.
      "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
        "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
          "type": "A String", # Type of the age range.
        },
        "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
          "categoryId": "A String", # Required. The criterion ID of the category.
        },
        "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
          "type": "A String", # Type of the device.
        },
        "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
          "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
        },
        "gender": { # A gender criterion. # An audience attribute defined by a gender.
          "type": "A String", # Type of the gender.
        },
        "incomeRange": { # An income range criterion. # A household income percentile range.
          "type": "A String", # Type of the income range.
        },
        "lineup": { # A YouTube Lineup. # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
        "location": { # A location criterion. # An audience attribute defined by a geographic location.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
          "type": "A String", # Type of the parental status.
        },
        "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
          "userInterestCategory": "A String", # The UserInterest resource name.
        },
        "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
          "userList": "A String", # The User List resource name.
        },
        "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
          "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
        },
        "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
          "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
        },
      },
      "dimension": "A String", # The type of the attribute.
      "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
      "displayName": "A String", # The human-readable name of the attribute.
      "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
        "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
          "A String",
        ],
        "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
          # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
        ],
      },
      "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
        "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
        "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
        "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
        "sampleChannels": [ # Examples of channels that are included in the lineup.
          { # A YouTube channel returned as an example of the content in a lineup.
            "displayName": "A String", # The name of the sample channel.
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
              "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
            },
          },
        ],
      },
      "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
        "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      },
      "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
      "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
        "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
      },
      "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
        "userListType": "A String", # The user list type.
      },
      "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
        "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
      },
      "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
        "commentsCount": "A String", # The total number of comments.
        "likesCount": "A String", # The total number of likes.
        "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
        "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
        "videoProperties": [ # The properties of this video (such as shorts, live stream).
          "A String",
        ],
        "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
        "viewsCount": "A String", # The total number of views.
      },
    },
  ],
}

generateAudienceOverlapInsights(customerId, body=None, x__xgafv=None)

Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateAudienceOverlapInsights.
  "countryLocation": { # A location criterion. # Required. The country in which to calculate the sizes and overlaps of audiences.
    "geoTargetConstant": "A String", # The geo target constant resource name.
  },
  "customerInsightsGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "dimensions": [ # Required. The types of attributes of which to calculate the overlap with the primary_attribute. The values must be a subset of AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
    "A String",
  ],
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
  "primaryAttribute": { # An audience attribute that can be used to request insights about the audience. # Required. The audience attribute that should be intersected with all other eligible audiences. This must be an Affinity or In-Market UserInterest, an AgeRange or a Gender.
    "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
      "type": "A String", # Type of the age range.
    },
    "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
      "categoryId": "A String", # Required. The criterion ID of the category.
    },
    "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
      "type": "A String", # Type of the device.
    },
    "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
      "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
    },
    "gender": { # A gender criterion. # An audience attribute defined by a gender.
      "type": "A String", # Type of the gender.
    },
    "incomeRange": { # An income range criterion. # A household income percentile range.
      "type": "A String", # Type of the income range.
    },
    "lineup": { # A YouTube Lineup. # A YouTube Lineup.
      "lineupId": "A String", # Required. The numeric ID of the lineup.
    },
    "location": { # A location criterion. # An audience attribute defined by a geographic location.
      "geoTargetConstant": "A String", # The geo target constant resource name.
    },
    "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
      "type": "A String", # Type of the parental status.
    },
    "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
      "userInterestCategory": "A String", # The UserInterest resource name.
    },
    "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
      "userList": "A String", # The User List resource name.
    },
    "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
      "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
    },
    "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
      "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.GenerateAudienceOverlapInsights.
  "dimensionResults": [ # Lists of attributes and their overlap with the primary attribute, one list per requested dimension.
    { # A list of audience attributes of a single dimension, including their overlap with a primary attribute, returned as part of a GenerateAudienceOverlapInsightsResponse.
      "dimension": "A String", # The dimension of all the attributes in this section.
      "items": [ # The attributes and their overlap with the primary attribute.
        { # An audience attribute, with metadata including the overlap between this attribute's potential YouTube reach and that of a primary attribute.
          "attributeMetadata": { # An audience attribute, with metadata about it, returned in response to a search. # The attribute and its metadata, including potential YouTube reach.
            "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
              "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                "type": "A String", # Type of the age range.
              },
              "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                "categoryId": "A String", # Required. The criterion ID of the category.
              },
              "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                "type": "A String", # Type of the device.
              },
              "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
              },
              "gender": { # A gender criterion. # An audience attribute defined by a gender.
                "type": "A String", # Type of the gender.
              },
              "incomeRange": { # An income range criterion. # A household income percentile range.
                "type": "A String", # Type of the income range.
              },
              "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                "lineupId": "A String", # Required. The numeric ID of the lineup.
              },
              "location": { # A location criterion. # An audience attribute defined by a geographic location.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                "type": "A String", # Type of the parental status.
              },
              "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                "userInterestCategory": "A String", # The UserInterest resource name.
              },
              "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                "userList": "A String", # The User List resource name.
              },
              "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
              },
              "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
              },
            },
            "dimension": "A String", # The type of the attribute.
            "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
            "displayName": "A String", # The human-readable name of the attribute.
            "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
              "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
                "A String",
              ],
              "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
                # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
              ],
            },
            "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
              "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
              "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
              "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
              "sampleChannels": [ # Examples of channels that are included in the lineup.
                { # A YouTube channel returned as an example of the content in a lineup.
                  "displayName": "A String", # The name of the sample channel.
                  "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                  },
                  "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                    "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                  },
                },
              ],
            },
            "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
              "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
            },
            "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
            "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
            "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
              "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
            },
            "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
              "userListType": "A String", # The user list type.
            },
            "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
            "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
              "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
            },
            "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
              "commentsCount": "A String", # The total number of comments.
              "likesCount": "A String", # The total number of likes.
              "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
              "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
              "videoProperties": [ # The properties of this video (such as shorts, live stream).
                "A String",
              ],
              "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
              "viewsCount": "A String", # The total number of views.
            },
          },
          "potentialYoutubeReachIntersection": "A String", # The estimated size of the intersection of this audience attribute with the primary attribute, that is, the number of reachable YouTube users who match BOTH the primary attribute and this one.
        },
      ],
    },
  ],
  "primaryAttributeMetadata": { # An audience attribute, with metadata about it, returned in response to a search. # Metadata for the primary attribute, including potential YouTube reach.
    "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
      "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
        "type": "A String", # Type of the age range.
      },
      "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
        "categoryId": "A String", # Required. The criterion ID of the category.
      },
      "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
        "type": "A String", # Type of the device.
      },
      "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
        "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
      },
      "gender": { # A gender criterion. # An audience attribute defined by a gender.
        "type": "A String", # Type of the gender.
      },
      "incomeRange": { # An income range criterion. # A household income percentile range.
        "type": "A String", # Type of the income range.
      },
      "lineup": { # A YouTube Lineup. # A YouTube Lineup.
        "lineupId": "A String", # Required. The numeric ID of the lineup.
      },
      "location": { # A location criterion. # An audience attribute defined by a geographic location.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
      "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
        "type": "A String", # Type of the parental status.
      },
      "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
        "userInterestCategory": "A String", # The UserInterest resource name.
      },
      "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
        "userList": "A String", # The User List resource name.
      },
      "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
        "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
      },
      "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
        "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
      },
    },
    "dimension": "A String", # The type of the attribute.
    "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
    "displayName": "A String", # The human-readable name of the attribute.
    "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
      "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
        "A String",
      ],
      "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
        # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
      ],
    },
    "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
      "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
      "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
      "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
      "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
      "sampleChannels": [ # Examples of channels that are included in the lineup.
        { # A YouTube channel returned as an example of the content in a lineup.
          "displayName": "A String", # The name of the sample channel.
          "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
          },
          "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
            "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
          },
        },
      ],
    },
    "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
      "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    },
    "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
    "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
    "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
      "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
    },
    "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
      "userListType": "A String", # The user list type.
    },
    "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
    "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
      "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
    },
    "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
      "commentsCount": "A String", # The total number of comments.
      "likesCount": "A String", # The total number of likes.
      "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
      "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
      "videoProperties": [ # The properties of this video (such as shorts, live stream).
        "A String",
      ],
      "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
      "viewsCount": "A String", # The total number of views.
    },
  },
}

generateBenchmarksMetrics(customerId, body=None, x__xgafv=None)

Returns YouTube advertisement metrics for the given client against industry benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BenchmarksError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. Supply a client customer ID to generate metrics for the customer. A manager account customer ID will not return customer metrics since it does not have any associated direct ad campaigns. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for BenchmarksService.GenerateBenchmarksMetrics.
  "applicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
  "benchmarksSource": { # The source used to generate benchmarks metrics for. The ID of the source can be obtained from BenchmarksService.ListBenchmarksSources. # Required. The source used to generate benchmarks metrics for.
    "industryVerticalId": "A String", # The ID of the Industry Vertical.
  },
  "currencyCode": "A String", # Optional. The three-character ISO 4217 currency code. If unspecified, the default currency for monetary values is USD.
  "customerBenchmarksGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "dateRange": { # A date range. # The date range to aggregate metrics over. If unset, data will be returned for the most recent quarter for which data is available. Dates can be retrieved using BenchmarksService.ListBenchmarksAvailableDates.
    "endDate": "A String", # The end date, in yyyy-mm-dd format. This date is inclusive.
    "startDate": "A String", # The start date, in yyyy-mm-dd format. This date is inclusive.
  },
  "location": { # A location criterion. # Required. The location to generate benchmarks metrics for.
    "geoTargetConstant": "A String", # The geo target constant resource name.
  },
  "productFilter": { # The type and list of products to aggregate benchmarks metrics over. # Required. The products to aggregate metrics over. Product filter settings support a list of product IDs or a list of marketing objectives.
    "marketingObjectiveList": { # The list of marketing objectives to generate benchmarks metrics for. # The list of marketing goals. Marketing objective is a broader product classification of products.
      "marketingObjectives": [ # Required. Marketing objectives to generate benchmarks metrics for.
        "A String",
      ],
    },
    "productList": { # The list of products to generate benchmarks metrics for. # The list of products.
      "productCodes": [ # Required. Products to generate benchmarks metrics for.
        "A String",
      ],
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BenchmarksService.GenerateBenchmarksMetrics.
  "averageBenchmarksMetrics": { # All metrics returned against a criteria. # Metrics for the selected benchmarks source.
    "averageRateMetrics": { # Average rate metrics. Metrics that represent monetary values are returned in USD by default, if unspecified in the request. # Average rate metrics calculated by dividing one metric by another.
      "activeViewViewability": 3.14, # The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
      "averageActiveViewCpm": 3.14, # Average cost-per-thousand viewable impressions.
      "averageCpc": 3.14, # The average cost-per-click (CPC) is defined by the total cost of all clicks divided by the total number of clicks received.
      "averageCpe": 3.14, # The average cost-per-engagement (CPE) is defined by the total cost of all ad engagements divided by the total number of ad engagements.
      "averageCpi": 3.14, # The average cost-per-interaction (CPI) is defined by the total cost of all interactions divided by the total number of interactions.
      "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM).
      "clickThroughRate": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
      "engagementRate": 3.14, # How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
      "interactionRate": 3.14, # How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
      "trueviewAverageCpv": 3.14, # The average TrueView cost-per-view (CPV) is defined by the total cost of all ad TrueView views divided by the number of TrueView views.
      "trueviewViewRate": 3.14, # Number of completed TrueView views divided by the number of impressions.
      "videoCompletionP100Rate": 3.14, # Percentage of impressions where the viewer watched all of your video.
      "videoCompletionP25Rate": 3.14, # Percentage of impressions where the viewer watched 25% of your video.
      "videoCompletionP50Rate": 3.14, # Percentage of impressions where the viewer watched 50% of your video.
      "videoCompletionP75Rate": 3.14, # Percentage of impressions where the viewer watched 75% of your video.
    },
  },
  "customerMetrics": { # All metrics returned against a criteria. # Metrics belonging to the customer.
    "averageRateMetrics": { # Average rate metrics. Metrics that represent monetary values are returned in USD by default, if unspecified in the request. # Average rate metrics calculated by dividing one metric by another.
      "activeViewViewability": 3.14, # The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
      "averageActiveViewCpm": 3.14, # Average cost-per-thousand viewable impressions.
      "averageCpc": 3.14, # The average cost-per-click (CPC) is defined by the total cost of all clicks divided by the total number of clicks received.
      "averageCpe": 3.14, # The average cost-per-engagement (CPE) is defined by the total cost of all ad engagements divided by the total number of ad engagements.
      "averageCpi": 3.14, # The average cost-per-interaction (CPI) is defined by the total cost of all interactions divided by the total number of interactions.
      "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM).
      "clickThroughRate": 3.14, # The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
      "engagementRate": 3.14, # How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
      "interactionRate": 3.14, # How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
      "trueviewAverageCpv": 3.14, # The average TrueView cost-per-view (CPV) is defined by the total cost of all ad TrueView views divided by the number of TrueView views.
      "trueviewViewRate": 3.14, # Number of completed TrueView views divided by the number of impressions.
      "videoCompletionP100Rate": 3.14, # Percentage of impressions where the viewer watched all of your video.
      "videoCompletionP25Rate": 3.14, # Percentage of impressions where the viewer watched 25% of your video.
      "videoCompletionP50Rate": 3.14, # Percentage of impressions where the viewer watched 50% of your video.
      "videoCompletionP75Rate": 3.14, # Percentage of impressions where the viewer watched 75% of your video.
    },
  },
}

generateInsightsFinderReport(customerId, body=None, x__xgafv=None)

Creates a saved report that can be viewed in the Insights Finder tool. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateInsightsFinderReport.
  "baselineAudience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # Required. A baseline audience for this report, typically all people in a region.
    "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
      { # An age range criterion.
        "type": "A String", # Type of the age range.
      },
    ],
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
      "type": "A String", # Type of the gender.
    },
    "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
      { # An income range criterion.
        "type": "A String", # Type of the income range.
      },
    ],
    "lineups": [ # Lineups representing the YouTube content viewed by the audience.
      { # A YouTube Lineup.
        "lineupId": "A String", # Required. The numeric ID of the lineup.
      },
    ],
    "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
      "type": "A String", # Type of the parental status.
    },
    "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
      { # A list of AudienceInsightsAttributes.
        "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
          { # An audience attribute that can be used to request insights about the audience.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
        ],
      },
    ],
    "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
      "userList": "A String", # The User List resource name.
    },
  },
  "customerInsightsGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
  "specificAudience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # Required. The specific audience of interest for this report. The insights in the report will be based on attributes more prevalent in this audience than in the report's baseline audience.
    "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
      { # An age range criterion.
        "type": "A String", # Type of the age range.
      },
    ],
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
      "type": "A String", # Type of the gender.
    },
    "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
      { # An income range criterion.
        "type": "A String", # Type of the income range.
      },
    ],
    "lineups": [ # Lineups representing the YouTube content viewed by the audience.
      { # A YouTube Lineup.
        "lineupId": "A String", # Required. The numeric ID of the lineup.
      },
    ],
    "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
      "type": "A String", # Type of the parental status.
    },
    "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
      { # A list of AudienceInsightsAttributes.
        "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
          { # An audience attribute that can be used to request insights about the audience.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
        ],
      },
    ],
    "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
      "userList": "A String", # The User List resource name.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for AudienceInsightsService.GenerateInsightsFinderReport, containing the shareable URL for the report.
  "savedReportUrl": "A String", # An HTTPS URL providing a deep link into the Insights Finder UI with the report inputs filled in according to the request.
}

generateKeywordForecastMetrics(customerId, body=None, x__xgafv=None)

Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for KeywordPlanIdeaService.GenerateKeywordForecastMetrics.
  "campaign": { # A campaign to do a keyword campaign forecast. # Required. The campaign used in the forecast.
    "adGroups": [ # The ad groups in the new campaign to forecast.
      { # An ad group that is part of a campaign to be forecasted.
        "biddableKeywords": [ # Required. The list of biddable keywords to be used in the ad group when doing the forecast. Requires at least one keyword.
          { # A biddable keyword part of an ad group.
            "keyword": { # A keyword criterion. # Required. Keyword. Must have text and match type.
              "matchType": "A String", # The match type of the keyword.
              "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
            },
            "maxCpcBidMicros": "A String", # A max cpc bid in micros that overrides the ad group level max cpc bid in forecast simulation. This value will override the max cpc value set in the bidding strategy and ad group. Only specify this field for bidding strategies that support max cpc values.
          },
        ],
        "maxCpcBidMicros": "A String", # The max cpc to use for the ad group when generating forecasted traffic. This value will override the max cpc value set in the bidding strategy. Only specify this field for bidding strategies that max cpc values.
        "negativeKeywords": [ # The details of the keyword. You should specify both the keyword text and match type.
          { # A keyword criterion.
            "matchType": "A String", # The match type of the keyword.
            "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
          },
        ],
      },
    ],
    "biddingStrategy": { # Supported bidding strategies for new campaign forecasts. # Required. The bidding strategy for the campaign.
      "manualCpcBiddingStrategy": { # Manual CPC Bidding Strategy. # Use manual CPC bidding strategy for forecasting.
        "dailyBudgetMicros": "A String", # Campaign level budget in micros. If set, a minimum value is enforced for the local currency used in the campaign. An error will occur showing the minimum value if this field is set too low.
        "maxCpcBidMicros": "A String", # Required. A bid in micros to be applied to ad groups within the campaign for a manual CPC bidding strategy.
      },
      "maximizeClicksBiddingStrategy": { # Maximize Clicks Bidding Strategy. # Use maximize clicks bidding strategy for forecasting.
        "dailyTargetSpendMicros": "A String", # Required. The daily target spend in micros to be used for estimation. A minimum value is enforced for the local currency used in the campaign. An error will occur showing the minimum value if this field is set too low.
        "maxCpcBidCeilingMicros": "A String", # Ceiling on max CPC bids in micros.
      },
      "maximizeConversionsBiddingStrategy": { # Maximize Conversions Bidding Strategy. # Use maximize conversions bidding strategy for forecasting.
        "dailyTargetSpendMicros": "A String", # Required. The daily target spend in micros to be used for estimation. This value must be greater than zero.
      },
    },
    "conversionRate": 3.14, # The expected conversion rate (number of conversions divided by number of total clicks) as defined by the user. This value is expressed as a decimal value, so an expected conversion rate of 2% should be entered as 0.02. If left empty, an estimated conversion rate will be used.
    "geoModifiers": [ # Locations to be targeted. Locations must be unique.
      { # Location Criterion bid modifier.
        "bidModifier": 3.14, # The associated multiplier for the criterion_id. If set, this value cannot be 0.
        "geoTargetConstant": "A String", # The resource name of the geo location to target. The resource name is of the format "geoTargetConstants/{criterion_id}".
      },
    ],
    "keywordPlanNetwork": "A String", # Required. The network used for targeting.
    "languageConstants": [ # The list of resource names of languages to be targeted. The resource name is of the format "languageConstants/{criterion_id}". See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of language criterion codes.
      "A String",
    ],
    "negativeKeywords": [ # The list of negative keywords to be used in the campaign when doing the forecast.
      { # A keyword criterion.
        "matchType": "A String", # The match type of the keyword.
        "text": "A String", # The text of the keyword (at most 80 characters and 10 words).
      },
    ],
  },
  "currencyCode": "A String", # The currency used for exchange rate conversion. By default, the account currency of the customer is used. Set this field only if the currency is different from the account currency. The list of valid currency codes can be found at https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
  "forecastPeriod": { # A date range. # The date range for the forecast. The start date must be in the future and end date must be within 1 year from today. The reference timezone used is the one of the Google Ads account belonging to the customer. If not set, a default date range from next Sunday to the following Saturday will be used.
    "endDate": "A String", # The end date, in yyyy-mm-dd format. This date is inclusive.
    "startDate": "A String", # The start date, in yyyy-mm-dd format. This date is inclusive.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KeywordPlanIdeaService.GenerateKeywordForecastMetrics.
  "campaignForecastMetrics": { # The forecast metrics for the planless keyword campaign. # Results of the campaign forecast.
    "averageCpaMicros": "A String", # Average cost per acquisition calculated as cost_micros / conversions.
    "averageCpcMicros": "A String", # The average cpc. Available only if clicks > 0.
    "clickThroughRate": 3.14, # The average click through rate. Available only if impressions > 0.
    "clicks": 3.14, # The total number of clicks.
    "conversionRate": 3.14, # Forecasted conversion rate.
    "conversions": 3.14, # Forecasted number of conversions: clicks * conversion_rate.
    "costMicros": "A String", # The total cost.
    "impressions": 3.14, # The total number of impressions.
  },
}

generateKeywordHistoricalMetrics(customerId, body=None, x__xgafv=None)

Returns a list of keyword historical metrics. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, The ID of the customer with the recommendation. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics.
  "aggregateMetrics": { # The aggregate metrics specification of the request. # The aggregate fields to include in response.
    "aggregateMetricTypes": [ # The list of aggregate metrics to fetch data.
      "A String",
    ],
  },
  "geoTargetConstants": [ # The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.
    "A String",
  ],
  "historicalMetricsOptions": { # Historical metrics options. # The options for historical metrics data.
    "includeAverageCpc": True or False, # Indicates whether to include average cost per click value. Average CPC is provided only for legacy support.
    "yearMonthRange": { # The year month range inclusive of the start and end months. Eg: A year month range to represent Jan 2020 would be: (Jan 2020, Jan 2020). # The year month range for historical metrics. If not specified, metrics for the past 12 months are returned. Search metrics are available for the past 4 years. If the search volume is not available for the entire year_month_range provided, the subset of the year month range for which search volume is available are returned.
      "end": { # Year month. # The inclusive end year month.
        "month": "A String", # The month of the year. (for example, FEBRUARY).
        "year": "A String", # The year (for example, 2020).
      },
      "start": { # Year month. # The inclusive start year month.
        "month": "A String", # The month of the year. (for example, FEBRUARY).
        "year": "A String", # The year (for example, 2020).
      },
    },
  },
  "includeAdultKeywords": True or False, # If true, adult keywords will be included in response. The default value is false.
  "keywordPlanNetwork": "A String", # Targeting network. If not set, Google Search And Partners Network will be used.
  "keywords": [ # A list of keywords to get historical metrics. Not all inputs will be returned as a result of near-exact deduplication. For example, if stats for "car" and "cars" are requested, only "car" will be returned. A maximum of 10,000 keywords can be used.
    "A String",
  ],
  "language": "A String", # The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics.
  "aggregateMetricResults": { # The aggregated historical metrics for keyword plan keywords. # The aggregate metrics for all keywords.
    "deviceSearches": [ # The aggregate searches for all the keywords segmented by device for the specified time. Supports the following device types: MOBILE, TABLET, DESKTOP. This is only set when KeywordPlanAggregateMetricTypeEnum.DEVICE is set in the KeywordPlanAggregateMetrics field in the request.
      { # The total searches for the device type during the specified time period.
        "device": "A String", # The device type.
        "searchCount": "A String", # The total searches for the device.
      },
    ],
  },
  "results": [ # List of keywords and their historical metrics.
    { # The result of generating keyword historical metrics.
      "closeVariants": [ # The list of close variants from the requested keywords whose stats are combined into this GenerateKeywordHistoricalMetricsResult.
        "A String",
      ],
      "keywordMetrics": { # Historical metrics specific to the targeting options selected. Targeting options include geographies, network, and so on. Refer to https://support.google.com/google-ads/answer/3022575 for more details. # The historical metrics for text and its close variants
        "averageCpcMicros": "A String", # Average Cost Per Click in micros for the keyword.
        "avgMonthlySearches": "A String", # Approximate number of monthly searches on this query, averaged for the past 12 months.
        "competition": "A String", # The competition level for the query.
        "competitionIndex": "A String", # The competition index for the query in the range [0, 100]. Shows how competitive ad placement is for a keyword. The level of competition from 0-100 is determined by the number of ad slots filled divided by the total number of ad slots available. If not enough data is available, null is returned.
        "highTopOfPageBidMicros": "A String", # Top of page bid high range (80th percentile) in micros for the keyword.
        "lowTopOfPageBidMicros": "A String", # Top of page bid low range (20th percentile) in micros for the keyword.
        "monthlySearchVolumes": [ # Approximate number of searches on this query for the past twelve months.
          { # Monthly search volume.
            "month": "A String", # The month of the search volume.
            "monthlySearches": "A String", # Approximate number of searches for the month. A null value indicates the search volume is unavailable for that month.
            "year": "A String", # The year of the search volume (for example, 2020).
          },
        ],
      },
      "text": "A String", # The text of the query associated with one or more keywords. Note that we de-dupe your keywords list, eliminating close variants before returning the keywords as text. For example, if your request originally contained the keywords "car" and "cars", the returned search query will only contain "cars". The list of de-duped queries will be included in close_variants field.
    },
  ],
}

generateKeywordIdeas(customerId, body=None, x__xgafv=None)

Returns a list of keyword ideas. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, The ID of the customer with the recommendation. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for KeywordPlanIdeaService.GenerateKeywordIdeas.
  "aggregateMetrics": { # The aggregate metrics specification of the request. # The aggregate fields to include in response.
    "aggregateMetricTypes": [ # The list of aggregate metrics to fetch data.
      "A String",
    ],
  },
  "geoTargetConstants": [ # The resource names of the location to target. Maximum is 10. An empty list MAY be used to specify all targeting geos.
    "A String",
  ],
  "historicalMetricsOptions": { # Historical metrics options. # The options for historical metrics data.
    "includeAverageCpc": True or False, # Indicates whether to include average cost per click value. Average CPC is provided only for legacy support.
    "yearMonthRange": { # The year month range inclusive of the start and end months. Eg: A year month range to represent Jan 2020 would be: (Jan 2020, Jan 2020). # The year month range for historical metrics. If not specified, metrics for the past 12 months are returned. Search metrics are available for the past 4 years. If the search volume is not available for the entire year_month_range provided, the subset of the year month range for which search volume is available are returned.
      "end": { # Year month. # The inclusive end year month.
        "month": "A String", # The month of the year. (for example, FEBRUARY).
        "year": "A String", # The year (for example, 2020).
      },
      "start": { # Year month. # The inclusive start year month.
        "month": "A String", # The month of the year. (for example, FEBRUARY).
        "year": "A String", # The year (for example, 2020).
      },
    },
  },
  "includeAdultKeywords": True or False, # If true, adult keywords will be included in response. The default value is false.
  "keywordAndUrlSeed": { # Keyword And Url Seed # A Keyword and a specific Url to generate ideas from for example, cars, www.example.com/cars.
    "keywords": [ # Requires at least one keyword and no more than 20 keywords.
      "A String",
    ],
    "url": "A String", # The URL to crawl in order to generate keyword ideas.
  },
  "keywordAnnotation": [ # The keyword annotations to include in response.
    "A String",
  ],
  "keywordPlanNetwork": "A String", # Targeting network. If not set, Google Search And Partners Network will be used.
  "keywordSeed": { # Keyword Seed # A Keyword or phrase to generate ideas from, for example, cars.
    "keywords": [ # Requires at least one keyword and no more than 20 keywords.
      "A String",
    ],
  },
  "language": "A String", # The resource name of the language to target. Each keyword belongs to some set of languages; a keyword is included if language is one of its languages. If not set, all keywords will be included.
  "pageSize": 42, # Number of results to retrieve in a single page. A maximum of 10,000 results may be returned, if the page_size exceeds this, it is ignored. If unspecified, at most 10,000 results will be returned. The server may decide to further limit the number of returned resources. If the response contains fewer than 10,000 results it may not be assumed as last page of results.
  "pageToken": "A String", # Token of the page to retrieve. If not specified, the first page of results will be returned. To request next page of results use the value obtained from `next_page_token` in the previous response. The request fields must match across pages.
  "siteSeed": { # Site Seed # The site to generate ideas from, for example, www.example.com.
    "site": "A String", # The domain name of the site. If the customer requesting the ideas doesn't own the site provided only public information is returned.
  },
  "urlSeed": { # Url Seed # A specific url to generate ideas from, for example, www.example.com/cars.
    "url": "A String", # The URL to crawl in order to generate keyword ideas.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KeywordPlanIdeaService.GenerateKeywordIdeas.
  "aggregateMetricResults": { # The aggregated historical metrics for keyword plan keywords. # The aggregate metrics for all keyword ideas.
    "deviceSearches": [ # The aggregate searches for all the keywords segmented by device for the specified time. Supports the following device types: MOBILE, TABLET, DESKTOP. This is only set when KeywordPlanAggregateMetricTypeEnum.DEVICE is set in the KeywordPlanAggregateMetrics field in the request.
      { # The total searches for the device type during the specified time period.
        "device": "A String", # The device type.
        "searchCount": "A String", # The total searches for the device.
      },
    ],
  },
  "nextPageToken": "A String", # Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.
  "results": [ # Results of generating keyword ideas.
    { # The result of generating keyword ideas.
      "closeVariants": [ # The list of close variants from the requested keywords that are combined into this GenerateKeywordIdeaResult. See https://support.google.com/google-ads/answer/9342105 for the definition of "close variants".
        "A String",
      ],
      "keywordAnnotations": { # The annotations for the keyword plan keywords. # The annotations for the keyword. The annotation data is only provided if requested.
        "concepts": [ # The list of concepts for the keyword.
          { # The concept for the keyword.
            "conceptGroup": { # The concept group for the keyword concept. # The concept group of the concept details.
              "name": "A String", # The concept group name.
              "type": "A String", # The concept group type.
            },
            "name": "A String", # The concept name for the keyword in the concept_group.
          },
        ],
      },
      "keywordIdeaMetrics": { # Historical metrics specific to the targeting options selected. Targeting options include geographies, network, and so on. Refer to https://support.google.com/google-ads/answer/3022575 for more details. # The historical metrics for the keyword.
        "averageCpcMicros": "A String", # Average Cost Per Click in micros for the keyword.
        "avgMonthlySearches": "A String", # Approximate number of monthly searches on this query, averaged for the past 12 months.
        "competition": "A String", # The competition level for the query.
        "competitionIndex": "A String", # The competition index for the query in the range [0, 100]. Shows how competitive ad placement is for a keyword. The level of competition from 0-100 is determined by the number of ad slots filled divided by the total number of ad slots available. If not enough data is available, null is returned.
        "highTopOfPageBidMicros": "A String", # Top of page bid high range (80th percentile) in micros for the keyword.
        "lowTopOfPageBidMicros": "A String", # Top of page bid low range (20th percentile) in micros for the keyword.
        "monthlySearchVolumes": [ # Approximate number of searches on this query for the past twelve months.
          { # Monthly search volume.
            "month": "A String", # The month of the search volume.
            "monthlySearches": "A String", # Approximate number of searches for the month. A null value indicates the search volume is unavailable for that month.
            "year": "A String", # The year of the search volume (for example, 2020).
          },
        ],
      },
      "text": "A String", # Text of the keyword idea. As in Keyword Plan historical metrics, this text may not be an actual keyword, but the canonical form of multiple keywords. See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
    },
  ],
  "totalSize": "A String", # Total number of results available.
}

generateKeywordIdeas_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

generateReachForecast(customerId, body=None, x__xgafv=None)

Generates a reach forecast for a given targeting / product mix. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ReachPlanService.GenerateReachForecast.
  "campaignDuration": { # The duration of a planned campaign. # Required. Campaign duration.
    "dateRange": { # A date range. # Date range of the campaign. Dates are in the yyyy-mm-dd format and inclusive. The end date must be < 1 year in the future and the date range must be <= 92 days long. This field cannot be combined with the duration_in_days field.
      "endDate": "A String", # The end date, in yyyy-mm-dd format. This date is inclusive.
      "startDate": "A String", # The start date, in yyyy-mm-dd format. This date is inclusive.
    },
    "durationInDays": 42, # The duration value in days. This field cannot be combined with the date_range field.
  },
  "cookieFrequencyCap": 42, # Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user. If not specified, no cap is applied. This field is deprecated in v4 and will eventually be removed. Use cookie_frequency_cap_setting instead.
  "cookieFrequencyCapSetting": { # A rule specifying the maximum number of times an ad can be shown to a user over a particular time period. # Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user during a specified time interval. If not specified, a default of 0 (no cap) is applied. This field replaces the deprecated cookie_frequency_cap field.
    "impressions": 42, # Required. The number of impressions, inclusive.
    "timeUnit": "A String", # Required. The type of time unit.
  },
  "currencyCode": "A String", # The currency code. Three-character ISO 4217 currency code.
  "customerReachGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "effectiveFrequencyLimit": { # Effective frequency limit. # The highest minimum effective frequency (the number of times a person was exposed to the ad) value [1-10] to include in Forecast.effective_frequency_breakdowns. If not specified, Forecast.effective_frequency_breakdowns will not be provided. The effective frequency value provided here will also be used as the minimum effective frequency for the reported reach metrics. This field cannot be combined with the min_effective_frequency field.
    "effectiveFrequencyBreakdownLimit": 42, # The highest effective frequency value to include in Forecast.effective_frequency_breakdowns. This field supports frequencies 1-10, inclusive.
  },
  "forecastMetricOptions": { # Controls forecast metrics to return. # Controls the forecast metrics returned in the response.
    "includeCoview": True or False, # Indicates whether to include co-view metrics in the response forecast.
  },
  "minEffectiveFrequency": 42, # Chosen minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10]. This won't affect the targeting, but just the reporting. If not specified, a default of 1 is applied. This field cannot be combined with the effective_frequency_limit field.
  "plannedProducts": [ # Required. The products to be forecast. The max number of allowed planned products is 15.
    { # A product being planned for reach.
      "advancedProductTargeting": { # Advanced targeting settings for products. # Targeting settings for the selected product. To list the available targeting for each product use ReachPlanService.ListPlannableProducts.
        "surfaceTargetingSettings": { # Container for surfaces for a product. Surfaces refer to the available types of ad inventories such as In-Feed, In-Stream, and Shorts. # Surface targeting settings for this product.
          "surfaces": [ # List of surfaces available to target.
            "A String",
          ],
        },
        "targetFrequencySettings": { # Target Frequency settings for a supported product. # Settings for a Target frequency campaign. Must be set when selecting the TARGET_FREQUENCY product. See https://support.google.com/google-ads/answer/12400225 for more information about Target Frequency campaigns.
          "targetFrequency": 42, # Required. The target frequency goal per selected time unit.
          "timeUnit": "A String", # Required. The time unit used to describe the time frame for target_frequency.
        },
        "youtubeSelectSettings": { # Request settings for YouTube Select Lineups # Settings for YouTube Select targeting.
          "lineupId": "A String", # Lineup for YouTube Select Targeting.
        },
      },
      "budgetMicros": "A String", # Required. Maximum budget allocation in micros for the selected product. The value is specified in the selected planning currency_code. For example: 1 000 000$ = 1 000 000 000 000 micros.
      "conversionRate": 3.14, # Conversion rate as a decimal between 0 and 1, exclusive. For example: if 2% of ad interactions are expected to lead to conversions, conversion_rate should be 0.02. This field is required for DEMAND_GEN plannable products. It is not supported for other plannable products.
      "plannableProductCode": "A String", # Required. Selected product for planning. The code associated with the ad product (for example: Trueview, Bumper). To list the available plannable product codes use ReachPlanService.ListPlannableProducts.
    },
  ],
  "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
  "targeting": { # The targeting for which traffic metrics will be reported. # The targeting to be applied to all products selected in the product mix. This is planned targeting: execution details might vary based on the advertising product, consult an implementation specialist. See specific metrics for details on how targeting affects them.
    "ageRange": "A String", # Targeted age range. An unset value is equivalent to targeting all ages.
    "audienceTargeting": { # Audience targeting for reach forecast. # Targeted audiences. If not specified, does not target any specific audience.
      "userInterest": [ # List of audiences based on user interests to be targeted.
        { # Represents a particular interest-based topic to be targeted.
          "userInterestCategory": "A String", # The UserInterest resource name.
        },
      ],
      "userLists": [ # List of audiences based on user lists to be targeted.
        { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted.
          "userList": "A String", # The User List resource name.
        },
      ],
    },
    "devices": [ # Targeted devices. If not specified, targets all applicable devices. Applicable devices vary by product and region and can be obtained from ReachPlanService.ListPlannableProducts.
      { # A device criterion.
        "type": "A String", # Type of the device.
      },
    ],
    "genders": [ # Targeted genders. An unset value is equivalent to targeting MALE and FEMALE.
      { # A gender criterion.
        "type": "A String", # Type of the gender.
      },
    ],
    "network": "A String", # Targetable network for the ad product. If not specified, targets all applicable networks. Applicable networks vary by product and region and can be obtained from ReachPlanService.ListPlannableProducts.
    "plannableLocationId": "A String", # The ID of the selected location. Plannable location IDs can be obtained from ReachPlanService.ListPlannableLocations. Requests must set either this field or `plannable_location_ids`. This field is deprecated as of V12 and will be removed in a future release. Use `plannable_location_ids` instead.
    "plannableLocationIds": [ # The list of plannable location IDs to target with this forecast. If more than one ID is provided, all IDs must have the same `parent_country_id`. Planning for more than `parent_county` is not supported. Plannable location IDs and their `parent_country_id` can be obtained from ReachPlanService.ListPlannableLocations. Requests must set either this field or `plannable_location_id`.
      "A String",
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message containing the generated reach curve.
  "onTargetAudienceMetrics": { # Audience metrics for the planned products. These metrics consider the following targeting dimensions: - Location - PlannableAgeRange - Gender - AudienceTargeting (only for youtube_audience_size) # Reference on target audiences for this curve.
    "censusAudienceSize": "A String", # Reference audience size matching the considered targeting for Census.
    "youtubeAudienceSize": "A String", # Reference audience size matching the considered targeting for YouTube.
  },
  "reachCurve": { # The reach curve for the planned products. # The generated reach curve for the planned product mix.
    "reachForecasts": [ # All points on the reach curve.
      { # A point on reach curve.
        "costMicros": "A String", # The cost in micros.
        "forecast": { # Forecasted traffic metrics for the planned products and targeting. # Forecasted traffic metrics for this point.
          "conversions": 3.14, # The number of conversions. This metric is only available for DEMAND_GEN plannable products. See https://support.google.com/google-ads/answer/2375431 for more information on conversions.
          "effectiveFrequencyBreakdowns": [ # A list of effective frequency forecasts. The list is ordered starting with 1+ and ending with the value set in GenerateReachForecastRequest.effective_frequency_limit. If no effective_frequency_limit was set, this list will be empty.
            { # A breakdown of the number of unique people reached at a given effective frequency.
              "effectiveCoviewReach": "A String", # The number of users (including co-viewing users) reached for the associated effective_frequency value.
              "effectiveFrequency": 42, # The effective frequency [1-10].
              "onTargetEffectiveCoviewReach": "A String", # The number of users (including co-viewing users) reached for the associated effective_frequency value within the specified plan demographic.
              "onTargetReach": "A String", # The number of unique people reached at least effective_frequency times that exactly matches the Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the on_target_reach value will be rounded to 0.
              "totalReach": "A String", # Total number of unique people reached at least effective_frequency times. This includes people that may fall outside the specified Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the total_reach value will be rounded to 0.
            },
          ],
          "onTargetCoviewImpressions": "A String", # Number of ad impressions that exactly matches the Targeting including co-viewers.
          "onTargetCoviewReach": "A String", # Number of unique people reached that exactly matches the Targeting including co-viewers.
          "onTargetImpressions": "A String", # Number of ad impressions that exactly matches the Targeting.
          "onTargetReach": "A String", # Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times that exactly matches the Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the on_target_reach value will be rounded to 0.
          "totalCoviewImpressions": "A String", # Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.
          "totalCoviewReach": "A String", # Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting.
          "totalImpressions": "A String", # Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.
          "totalReach": "A String", # Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times. This includes people that may fall outside the specified Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the total_reach value will be rounded to 0.
          "trueviewViews": "A String", # Number of ad views forecasted for the specified product and targeting. A TrueView View is counted when a viewer views a larger portion or the entirety of an ad beyond an impression. See https://support.google.com/google-ads/answer/2375431 for more information on TrueView Views.
          "viewableImpressions": "A String", # Number of times the ad's impressions were considered viewable. See https://support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured.
        },
        "plannedProductReachForecasts": [ # The forecasted allocation and traffic metrics for each planned product at this point on the reach curve.
          { # The forecasted allocation and traffic metrics for a specific product at a point on the reach curve.
            "costMicros": "A String", # The cost in micros. This may differ from the product's input allocation if one or more planned products cannot fulfill the budget because of limited inventory.
            "plannableProductCode": "A String", # Selected product for planning. The product codes returned are within the set of the ones returned by ListPlannableProducts when using the same location ID.
            "plannedProductForecast": { # Forecasted traffic metrics for a planned product. # Forecasted traffic metrics for this product.
              "averageFrequency": 3.14, # The number of times per selected time unit a user will see an ad, averaged over the number of time units in the forecast length. This field will only be populated for a Target Frequency campaign. See https://support.google.com/google-ads/answer/12400225 for more information about Target Frequency campaigns.
              "conversions": 3.14, # The number of conversions. This metric is only available for DEMAND_GEN plannable products. See https://support.google.com/google-ads/answer/2375431 for more information on conversions.
              "onTargetCoviewImpressions": "A String", # Number of ad impressions that exactly matches the Targeting including co-viewers.
              "onTargetCoviewReach": "A String", # Number of unique people reached that exactly matches the Targeting including co-viewers.
              "onTargetImpressions": "A String", # Number of ad impressions that exactly matches the Targeting.
              "onTargetReach": "A String", # Number of unique people reached that exactly matches the Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the on_target_reach value will be rounded to 0.
              "totalCoviewImpressions": "A String", # Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.
              "totalCoviewReach": "A String", # Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting.
              "totalImpressions": "A String", # Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.
              "totalReach": "A String", # Number of unique people reached. This includes people that may fall outside the specified Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the total_reach value will be rounded to 0.
              "trueviewViews": "A String", # Number of ad views forecasted for the specified product and targeting. A TrueView View is counted when a viewer views a larger portion or the entirety of an ad beyond an impression. See https://support.google.com/google-ads/answer/2375431 for more information on TrueView Views.
              "viewableImpressions": "A String", # Number of times the ad's impressions were considered viewable. See https://support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured.
            },
          },
        ],
      },
    ],
  },
}

generateSuggestedTargetingInsights(customerId, body=None, x__xgafv=None)

Returns a collection of targeting insights (e.g. targetable audiences) that are relevant to the requested audience. List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateSuggestedTargetingInsights.
  "audienceDefinition": { # A structured definition of the audience of interest for which insights are being requested in AudienceInsightsService. # Provide a seed audience to get suggestions for.
    "audience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # Required. The audience of interest for which insights are being requested.
      "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
        { # An age range criterion.
          "type": "A String", # Type of the age range.
        },
      ],
      "countryLocations": [ # Required. The countries for the audience.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
        "type": "A String", # Type of the gender.
      },
      "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
        { # An income range criterion.
          "type": "A String", # Type of the income range.
        },
      ],
      "lineups": [ # Lineups representing the YouTube content viewed by the audience.
        { # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
      ],
      "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
        "type": "A String", # Type of the parental status.
      },
      "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
        { # A list of AudienceInsightsAttributes.
          "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
            { # An audience attribute that can be used to request insights about the audience.
              "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                "type": "A String", # Type of the age range.
              },
              "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                "categoryId": "A String", # Required. The criterion ID of the category.
              },
              "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                "type": "A String", # Type of the device.
              },
              "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
              },
              "gender": { # A gender criterion. # An audience attribute defined by a gender.
                "type": "A String", # Type of the gender.
              },
              "incomeRange": { # An income range criterion. # A household income percentile range.
                "type": "A String", # Type of the income range.
              },
              "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                "lineupId": "A String", # Required. The numeric ID of the lineup.
              },
              "location": { # A location criterion. # An audience attribute defined by a geographic location.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                "type": "A String", # Type of the parental status.
              },
              "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                "userInterestCategory": "A String", # The UserInterest resource name.
              },
              "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                "userList": "A String", # The User List resource name.
              },
              "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
              },
              "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
              },
            },
          ],
        },
      ],
      "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
        "userList": "A String", # The User List resource name.
      },
    },
    "baselineAudience": { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService. # Optional. The baseline audience. The default, if unspecified, is all people in the same country as the audience of interest.
      "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
        { # An age range criterion.
          "type": "A String", # Type of the age range.
        },
      ],
      "countryLocations": [ # Required. The countries for the audience.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
        "type": "A String", # Type of the gender.
      },
      "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
        { # An income range criterion.
          "type": "A String", # Type of the income range.
        },
      ],
      "lineups": [ # Lineups representing the YouTube content viewed by the audience.
        { # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
      ],
      "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
        "type": "A String", # Type of the parental status.
      },
      "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
        { # A list of AudienceInsightsAttributes.
          "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
            { # An audience attribute that can be used to request insights about the audience.
              "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                "type": "A String", # Type of the age range.
              },
              "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                "categoryId": "A String", # Required. The criterion ID of the category.
              },
              "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                "type": "A String", # Type of the device.
              },
              "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
              },
              "gender": { # A gender criterion. # An audience attribute defined by a gender.
                "type": "A String", # Type of the gender.
              },
              "incomeRange": { # An income range criterion. # A household income percentile range.
                "type": "A String", # Type of the income range.
              },
              "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                "lineupId": "A String", # Required. The numeric ID of the lineup.
              },
              "location": { # A location criterion. # An audience attribute defined by a geographic location.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                "type": "A String", # Type of the parental status.
              },
              "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                "userInterestCategory": "A String", # The UserInterest resource name.
              },
              "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                "userList": "A String", # The User List resource name.
              },
              "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
              },
              "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
              },
            },
          ],
        },
      ],
      "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
        "userList": "A String", # The User List resource name.
      },
    },
    "dataMonth": "A String", # Optional. The one-month range of historical data to use for insights, in the format "yyyy-mm". If unset, insights will be returned for the last thirty days of data.
  },
  "audienceDescription": { # A text description of the audience of interest for which insights are being requested in AudienceInsightsService. # Provide a text description of an audience to get AI-generated targeting suggestions. This can take around 5 or more seconds to complete.
    "audienceDescription": "A String", # Required. An English language text description of an audience to get suggestions for. Maximum length is 2000 characters. For example, "Women in their 30s who love to travel".
    "audienceDimensions": { # A collection of dimensions to be used for generating insights. # Optional. An optional list of audience dimensions to return.
      "dimensions": [ # Required. A list of dimensions.
        "A String",
      ],
    },
    "countryLocations": [ # Required. The countries for the audience.
      { # A location criterion.
        "geoTargetConstant": "A String", # The geo target constant resource name.
      },
    ],
    "marketingObjective": "A String", # Optional. An optional marketing objective which will influence the type of suggestions produced.
  },
  "customerInsightsGroup": "A String", # Optional. The name of the customer being planned for. This is a user-defined value.
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.GenerateSuggestedTargetingInsights.
  "suggestions": [ # Suggested insights for targetable audiences.
    { # A suggested targetable audience relevant to the requested audience.
      "ageRanges": [ # Suggested age targeting; may be empty indicating no age targeting.
        { # An age range criterion.
          "type": "A String", # Type of the age range.
        },
      ],
      "coverage": 3.14, # The fraction (from 0 to 1 inclusive) of the requested audience that can be reached using the suggested targeting.
      "gender": { # A gender criterion. # Suggested gender targeting. If present, this attribute has dimension GENDER.
        "type": "A String", # Type of the gender.
      },
      "index": 3.14, # The ratio of coverage to the coverage of the baseline audience or zero if this ratio is undefined or is not meaningful.
      "locations": [ # Suggested location targeting. These attributes all have dimension GEO_TARGET_COUNTRY or SUB_COUNTRY_LOCATION
        { # An audience attribute, with metadata about it, returned in response to a search.
          "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
          "dimension": "A String", # The type of the attribute.
          "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
          "displayName": "A String", # The human-readable name of the attribute.
          "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
            "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
              "A String",
            ],
            "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
              # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
            ],
          },
          "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
            "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
            "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
            "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
            "sampleChannels": [ # Examples of channels that are included in the lineup.
              { # A YouTube channel returned as an example of the content in a lineup.
                "displayName": "A String", # The name of the sample channel.
                "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                  "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                },
                "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                  "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                },
              },
            ],
          },
          "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
            "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
          },
          "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
          "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
          "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
            "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
          },
          "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
            "userListType": "A String", # The user list type.
          },
          "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
          "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
            "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
          },
          "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
            "commentsCount": "A String", # The total number of comments.
            "likesCount": "A String", # The total number of likes.
            "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
            "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
            "videoProperties": [ # The properties of this video (such as shorts, live stream).
              "A String",
            ],
            "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
            "viewsCount": "A String", # The total number of views.
          },
        },
      ],
      "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
        "type": "A String", # Type of the parental status.
      },
      "potentialYoutubeReach": "A String", # The approximate estimated number of people that can be reached on YouTube using this targeting.
      "userInterests": [ # List of user interest attributes with metadata defining the audience. The combination has a logical AND-of-ORs structure: The attributes within each AudienceInsightsAttributeMetadataGroup are ORed, and the groups themselves are ANDed.
        { # A group of audience attributes with metadata, returned in response to a search.
          "attributes": [ # Attributes with metadata returned in response to a search.
            { # An audience attribute, with metadata about it, returned in response to a search.
              "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
                "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                  "type": "A String", # Type of the age range.
                },
                "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                  "categoryId": "A String", # Required. The criterion ID of the category.
                },
                "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                  "type": "A String", # Type of the device.
                },
                "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                  "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
                },
                "gender": { # A gender criterion. # An audience attribute defined by a gender.
                  "type": "A String", # Type of the gender.
                },
                "incomeRange": { # An income range criterion. # A household income percentile range.
                  "type": "A String", # Type of the income range.
                },
                "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                  "lineupId": "A String", # Required. The numeric ID of the lineup.
                },
                "location": { # A location criterion. # An audience attribute defined by a geographic location.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
                "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                  "type": "A String", # Type of the parental status.
                },
                "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                  "userInterestCategory": "A String", # The UserInterest resource name.
                },
                "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                  "userList": "A String", # The User List resource name.
                },
                "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                  "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                },
                "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                  "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
                },
              },
              "dimension": "A String", # The type of the attribute.
              "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
              "displayName": "A String", # The human-readable name of the attribute.
              "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
                "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
                  "A String",
                ],
                "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
                  # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
                ],
              },
              "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
                "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
                "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
                "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
                "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
                "sampleChannels": [ # Examples of channels that are included in the lineup.
                  { # A YouTube channel returned as an example of the content in a lineup.
                    "displayName": "A String", # The name of the sample channel.
                    "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                      "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                    },
                    "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                      "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                    },
                  },
                ],
              },
              "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
                "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
              },
              "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
              "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
              "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
                "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
              },
              "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
                "userListType": "A String", # The user list type.
              },
              "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
              "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
                "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
              },
              "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
                "commentsCount": "A String", # The total number of comments.
                "likesCount": "A String", # The total number of likes.
                "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
                "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
                "videoProperties": [ # The properties of this video (such as shorts, live stream).
                  "A String",
                ],
                "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
                "viewsCount": "A String", # The total number of views.
              },
            },
          ],
        },
      ],
    },
  ],
}

generateTargetingSuggestionMetrics(customerId, body=None, x__xgafv=None)

Returns potential reach metrics for targetable audiences. This method helps answer questions like "How many Men aged 18+ interested in Camping can be reached on YouTube?" List of thrown errors: [AudienceInsightsError]() [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.GenerateTargetingSuggestionMetrics.
  "audiences": [ # Required. Audiences to request metrics for.
    { # A set of users, defined by various characteristics, for which insights can be requested in AudienceInsightsService.
      "ageRanges": [ # Age ranges for the audience. If absent, the audience represents all people over 18 that match the other attributes.
        { # An age range criterion.
          "type": "A String", # Type of the age range.
        },
      ],
      "countryLocations": [ # Required. The countries for the audience.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "gender": { # A gender criterion. # Gender for the audience. If absent, the audience does not restrict by gender.
        "type": "A String", # Type of the gender.
      },
      "incomeRanges": [ # Household income percentile ranges for the audience. If absent, the audience does not restrict by household income range.
        { # An income range criterion.
          "type": "A String", # Type of the income range.
        },
      ],
      "lineups": [ # Lineups representing the YouTube content viewed by the audience.
        { # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
      ],
      "parentalStatus": { # A parental status criterion. # Parental status for the audience. If absent, the audience does not restrict by parental status.
        "type": "A String", # Type of the parental status.
      },
      "subCountryLocations": [ # Sub-country geographic location attributes. If present, each of these must be contained in one of the countries in this audience. If absent, the audience is geographically to the country_locations and no further.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
      "topicAudienceCombinations": [ # A combination of entity, category and user interest attributes defining the audience. The combination has a logical AND-of-ORs structure: Attributes within each InsightsAudienceAttributeGroup are combined with OR, and the combinations themselves are combined together with AND. For example, the expression (Entity OR Affinity) AND (In-Market OR Category) can be formed using two InsightsAudienceAttributeGroups with two Attributes each.
        { # A list of AudienceInsightsAttributes.
          "attributes": [ # Required. A collection of audience attributes to be combined with logical OR. Attributes need not all be the same dimension. Only Knowledge Graph entities, Product & Service Categories, and Affinity and In-Market audiences are supported in this context.
            { # An audience attribute that can be used to request insights about the audience.
              "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                "type": "A String", # Type of the age range.
              },
              "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                "categoryId": "A String", # Required. The criterion ID of the category.
              },
              "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                "type": "A String", # Type of the device.
              },
              "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
              },
              "gender": { # A gender criterion. # An audience attribute defined by a gender.
                "type": "A String", # Type of the gender.
              },
              "incomeRange": { # An income range criterion. # A household income percentile range.
                "type": "A String", # Type of the income range.
              },
              "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                "lineupId": "A String", # Required. The numeric ID of the lineup.
              },
              "location": { # A location criterion. # An audience attribute defined by a geographic location.
                "geoTargetConstant": "A String", # The geo target constant resource name.
              },
              "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                "type": "A String", # Type of the parental status.
              },
              "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                "userInterestCategory": "A String", # The UserInterest resource name.
              },
              "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                "userList": "A String", # The User List resource name.
              },
              "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
              },
              "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
              },
            },
          ],
        },
      ],
      "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # User list to be targeted by the audience.
        "userList": "A String", # The User List resource name.
      },
    },
  ],
  "customerInsightsGroup": "A String", # Optional. The name of the customer being planned for. This is a user-defined value.
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.GenerateTargetingSuggestionMetrics.
  "suggestions": [ # Suggested targetable audiences. There will be one suggestion for each GenerateTargetingSuggestionMetricsRequest.audiences requested, matching the order requested.
    { # A suggested targetable audience relevant to the requested audience.
      "ageRanges": [ # Suggested age targeting; may be empty indicating no age targeting.
        { # An age range criterion.
          "type": "A String", # Type of the age range.
        },
      ],
      "coverage": 3.14, # The fraction (from 0 to 1 inclusive) of the requested audience that can be reached using the suggested targeting.
      "gender": { # A gender criterion. # Suggested gender targeting. If present, this attribute has dimension GENDER.
        "type": "A String", # Type of the gender.
      },
      "index": 3.14, # The ratio of coverage to the coverage of the baseline audience or zero if this ratio is undefined or is not meaningful.
      "locations": [ # Suggested location targeting. These attributes all have dimension GEO_TARGET_COUNTRY or SUB_COUNTRY_LOCATION
        { # An audience attribute, with metadata about it, returned in response to a search.
          "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
            "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
              "type": "A String", # Type of the age range.
            },
            "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
              "categoryId": "A String", # Required. The criterion ID of the category.
            },
            "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
              "type": "A String", # Type of the device.
            },
            "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
              "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
            },
            "gender": { # A gender criterion. # An audience attribute defined by a gender.
              "type": "A String", # Type of the gender.
            },
            "incomeRange": { # An income range criterion. # A household income percentile range.
              "type": "A String", # Type of the income range.
            },
            "lineup": { # A YouTube Lineup. # A YouTube Lineup.
              "lineupId": "A String", # Required. The numeric ID of the lineup.
            },
            "location": { # A location criterion. # An audience attribute defined by a geographic location.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
              "type": "A String", # Type of the parental status.
            },
            "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
              "userInterestCategory": "A String", # The UserInterest resource name.
            },
            "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
              "userList": "A String", # The User List resource name.
            },
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
              "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
            },
          },
          "dimension": "A String", # The type of the attribute.
          "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
          "displayName": "A String", # The human-readable name of the attribute.
          "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
            "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
              "A String",
            ],
            "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
              # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
            ],
          },
          "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
            "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
            "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
            "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
            "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
            "sampleChannels": [ # Examples of channels that are included in the lineup.
              { # A YouTube channel returned as an example of the content in a lineup.
                "displayName": "A String", # The name of the sample channel.
                "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                  "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                },
                "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                  "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                },
              },
            ],
          },
          "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
            "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
              "geoTargetConstant": "A String", # The geo target constant resource name.
            },
          },
          "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
          "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
          "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
            "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
          },
          "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
            "userListType": "A String", # The user list type.
          },
          "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
          "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
            "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
          },
          "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
            "commentsCount": "A String", # The total number of comments.
            "likesCount": "A String", # The total number of likes.
            "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
            "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
            "videoProperties": [ # The properties of this video (such as shorts, live stream).
              "A String",
            ],
            "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
            "viewsCount": "A String", # The total number of views.
          },
        },
      ],
      "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
        "type": "A String", # Type of the parental status.
      },
      "potentialYoutubeReach": "A String", # The approximate estimated number of people that can be reached on YouTube using this targeting.
      "userInterests": [ # List of user interest attributes with metadata defining the audience. The combination has a logical AND-of-ORs structure: The attributes within each AudienceInsightsAttributeMetadataGroup are ORed, and the groups themselves are ANDed.
        { # A group of audience attributes with metadata, returned in response to a search.
          "attributes": [ # Attributes with metadata returned in response to a search.
            { # An audience attribute, with metadata about it, returned in response to a search.
              "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
                "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
                  "type": "A String", # Type of the age range.
                },
                "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
                  "categoryId": "A String", # Required. The criterion ID of the category.
                },
                "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
                  "type": "A String", # Type of the device.
                },
                "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
                  "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
                },
                "gender": { # A gender criterion. # An audience attribute defined by a gender.
                  "type": "A String", # Type of the gender.
                },
                "incomeRange": { # An income range criterion. # A household income percentile range.
                  "type": "A String", # Type of the income range.
                },
                "lineup": { # A YouTube Lineup. # A YouTube Lineup.
                  "lineupId": "A String", # Required. The numeric ID of the lineup.
                },
                "location": { # A location criterion. # An audience attribute defined by a geographic location.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
                "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
                  "type": "A String", # Type of the parental status.
                },
                "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
                  "userInterestCategory": "A String", # The UserInterest resource name.
                },
                "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
                  "userList": "A String", # The User List resource name.
                },
                "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                  "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                },
                "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
                  "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
                },
              },
              "dimension": "A String", # The type of the attribute.
              "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
              "displayName": "A String", # The human-readable name of the attribute.
              "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
                "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
                  "A String",
                ],
                "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
                  # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
                ],
              },
              "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
                "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
                "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
                "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
                "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
                "sampleChannels": [ # Examples of channels that are included in the lineup.
                  { # A YouTube channel returned as an example of the content in a lineup.
                    "displayName": "A String", # The name of the sample channel.
                    "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
                      "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
                    },
                    "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
                      "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
                    },
                  },
                ],
              },
              "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
                "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
                  "geoTargetConstant": "A String", # The geo target constant resource name.
                },
              },
              "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
              "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
              "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
                "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
              },
              "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
                "userListType": "A String", # The user list type.
              },
              "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
              "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
                "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
              },
              "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
                "commentsCount": "A String", # The total number of comments.
                "likesCount": "A String", # The total number of likes.
                "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
                "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
                "videoProperties": [ # The properties of this video (such as shorts, live stream).
                  "A String",
                ],
                "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
                "viewsCount": "A String", # The total number of views.
              },
            },
          ],
        },
      ],
    },
  ],
}

getIdentityVerification(customerId, x__xgafv=None)

Returns Identity Verification information. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer for whom we are requesting verification information. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for GetIdentityVerification.
  "identityVerification": [ # List of identity verifications for the customer.
    { # An identity verification for a customer.
      "identityVerificationRequirement": { # Information regarding the verification requirement for a verification program type. # The verification requirement for this verification program for this customer.
        "verificationCompletionDeadlineTime": "A String", # The deadline to submit verification.
        "verificationStartDeadlineTime": "A String", # The deadline to start verification in "yyyy-MM-dd HH:mm:ss" format.
      },
      "verificationProgram": "A String", # The verification program type.
      "verificationProgress": { # Information regarding the verification progress for a verification program type. # Information regarding progress for this verification program for this customer.
        "actionUrl": "A String", # Action URL for user to complete verification for the given verification program type.
        "invitationLinkExpirationTime": "A String", # The timestamp when the action url will expire in "yyyy-MM-dd HH:mm:ss" format.
        "programStatus": "A String", # Current Status (PENDING_USER_ACTION, SUCCESS, FAILURE etc)
      },
    },
  ],
}

listAccessibleCustomers(x__xgafv=None)

Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for CustomerService.ListAccessibleCustomers.
  "resourceNames": [ # Resource name of customers directly accessible by the user authenticating the call.
    "A String",
  ],
}

mutate(customerId, body=None, x__xgafv=None)

Updates a customer. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldMaskError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [UrlFieldError]()

Args:
  customerId: string, Required. The ID of the customer being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CustomerService.MutateCustomer.
  "operation": { # A single update on a customer. # Required. The operation to perform on the customer
    "update": { # A customer. # Mutate operation. Only updates are supported for customer.
      "accountLevel": "A String", # Output only. The account level of the customer: Manager, Sub-manager, Associate manager, Service account.
      "accountStatus": "A String", # Output only. Account status, for example, Enabled, Paused, Removed, etc.
      "accountType": "A String", # Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.
      "associateManagerDescriptiveName": "A String", # Output only. The descriptive name of the associate manager.
      "associateManagerId": "A String", # Output only. The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.
      "autoTaggingEnabled": True or False, # Whether auto-tagging is enabled for the customer.
      "callReportingSetting": { # Call reporting setting for a customer. # Call reporting setting for a customer.
        "callConversionAction": "A String", # Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
        "callConversionReportingEnabled": True or False, # Whether to enable call conversion reporting.
        "callReportingEnabled": True or False, # Enable reporting of phone call events by redirecting them through Google System.
      },
      "containsEuPoliticalAdvertising": "A String", # Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update the self-declaration status of individual campaigns.
      "conversionTrackingSetting": { # A collection of customer-wide settings related to Search Ads 360 Conversion Tracking. # Conversion tracking setting for a customer.
        "acceptedCustomerDataTerms": True or False, # Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
        "conversionTrackingId": "A String", # Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
        "conversionTrackingStatus": "A String", # Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
        "crossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.
        "enhancedConversionsForLeadsEnabled": True or False, # Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
        "googleAdsConversionCustomer": "A String", # The resource name of the customer where conversions are created and managed. This field is read-only.
        "googleAdsCrossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
      },
      "creationTime": "A String", # Output only. The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
      "currencyCode": "A String", # Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
      "customerAgreementSetting": { # Customer Agreement Setting for a customer. # Output only. Customer Agreement Setting for a customer.
        "acceptedLeadFormTerms": True or False, # Output only. Whether the customer has accepted lead form term of service.
      },
      "descriptiveName": "A String", # Optional, non-unique descriptive name of the customer.
      "doubleClickCampaignManagerSetting": { # DoubleClick Campaign Manager (DCM) setting for a manager customer. # Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer.
        "advertiserId": "A String", # Output only. ID of the Campaign Manager advertiser associated with this customer.
        "networkId": "A String", # Output only. ID of the Campaign Manager network associated with this customer.
        "timeZone": "A String", # Output only. Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.
      },
      "engineId": "A String", # Output only. ID of the account in the external engine account.
      "finalUrlSuffix": "A String", # The URL template for appending params to the final URL.
      "hasPartnersBadge": True or False, # Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
      "id": "A String", # Output only. The ID of the customer.
      "imageAssetAutoMigrationDone": True or False, # Output only. True if feed based image has been migrated to asset based image.
      "imageAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
      "lastModifiedTime": "A String", # Output only. The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
      "localServicesSettings": { # Settings for Local Services customer. # Output only. Settings for Local Services customer.
        "granularInsuranceStatuses": [ # Output only. A read-only list of geo vertical level insurance statuses.
          { # Insurance status at geo + vertical level.
            "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
            "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
            "verificationStatus": "A String", # Output only. Granular insurance status, per geo + vertical.
          },
        ],
        "granularLicenseStatuses": [ # Output only. A read-only list of geo vertical level license statuses.
          { # License status at geo + vertical level.
            "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
            "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
            "verificationStatus": "A String", # Output only. Granular license status, per geo + vertical.
          },
        ],
      },
      "locationAssetAutoMigrationDone": True or False, # Output only. True if feed based location has been migrated to asset based location.
      "locationAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
      "manager": True or False, # Output only. Whether the customer is a manager.
      "managerDescriptiveName": "A String", # Output only. The descriptive name of the manager.
      "managerId": "A String", # Output only. The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.
      "optimizationScore": 3.14, # Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
      "optimizationScoreWeight": 3.14, # Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
      "payPerConversionEligibilityFailureReasons": [ # Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
        "A String",
      ],
      "remarketingSetting": { # Remarketing setting for a customer. # Output only. Remarketing setting for a customer.
        "googleGlobalSiteTag": "A String", # Output only. The Google tag.
      },
      "resourceName": "A String", # Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
      "status": "A String", # Output only. The status of the customer.
      "subManagerDescriptiveName": "A String", # Output only. The descriptive name of the sub manager.
      "subManagerId": "A String", # Output only. The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.
      "testAccount": True or False, # Output only. Whether the customer is a test account.
      "timeZone": "A String", # Immutable. The local timezone ID of the customer.
      "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL out of parameters.
      "videoBrandSafetySuitability": "A String", # Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
      "videoCustomer": { # Video specific information about a Customer. # Video specific information about a Customer.
        "thirdPartyIntegrationPartners": { # Container for Customer level third party integration partners. # Third Party integration partners.
          "brandLiftIntegrationPartners": [ # Allowed third party integration partners for Brand Lift verification.
            { # Container for third party Brand Lift integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "brandLiftIntegrationPartner": "A String", # Allowed Third Party integration partners for Brand Lift verification.
            },
          ],
          "brandSafetyIntegrationPartners": [ # Allowed third party integration partners for brand safety verification.
            { # Container for third party brand safety integration data for Customer.
              "brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
            },
          ],
          "reachIntegrationPartners": [ # Allowed third party integration partners for reach verification.
            { # Container for third party reach integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "reachIntegrationPartner": "A String", # Allowed Third Party integration partners for reach verification.
            },
          ],
          "viewabilityIntegrationPartners": [ # Allowed third party integration partners for YouTube viewability verification.
            { # Container for third party viewability integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
            },
          ],
        },
      },
    },
    "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
  },
  "responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
  "validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for customer mutate.
  "result": { # The result for the customer mutate. # Result for the mutate.
    "customer": { # A customer. # The mutated customer with only mutable fields after mutate. The fields will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
      "accountLevel": "A String", # Output only. The account level of the customer: Manager, Sub-manager, Associate manager, Service account.
      "accountStatus": "A String", # Output only. Account status, for example, Enabled, Paused, Removed, etc.
      "accountType": "A String", # Output only. Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.
      "associateManagerDescriptiveName": "A String", # Output only. The descriptive name of the associate manager.
      "associateManagerId": "A String", # Output only. The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.
      "autoTaggingEnabled": True or False, # Whether auto-tagging is enabled for the customer.
      "callReportingSetting": { # Call reporting setting for a customer. # Call reporting setting for a customer.
        "callConversionAction": "A String", # Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
        "callConversionReportingEnabled": True or False, # Whether to enable call conversion reporting.
        "callReportingEnabled": True or False, # Enable reporting of phone call events by redirecting them through Google System.
      },
      "containsEuPoliticalAdvertising": "A String", # Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update the self-declaration status of individual campaigns.
      "conversionTrackingSetting": { # A collection of customer-wide settings related to Search Ads 360 Conversion Tracking. # Conversion tracking setting for a customer.
        "acceptedCustomerDataTerms": True or False, # Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
        "conversionTrackingId": "A String", # Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
        "conversionTrackingStatus": "A String", # Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
        "crossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.
        "enhancedConversionsForLeadsEnabled": True or False, # Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
        "googleAdsConversionCustomer": "A String", # The resource name of the customer where conversions are created and managed. This field is read-only.
        "googleAdsCrossAccountConversionTrackingId": "A String", # Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
      },
      "creationTime": "A String", # Output only. The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
      "currencyCode": "A String", # Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
      "customerAgreementSetting": { # Customer Agreement Setting for a customer. # Output only. Customer Agreement Setting for a customer.
        "acceptedLeadFormTerms": True or False, # Output only. Whether the customer has accepted lead form term of service.
      },
      "descriptiveName": "A String", # Optional, non-unique descriptive name of the customer.
      "doubleClickCampaignManagerSetting": { # DoubleClick Campaign Manager (DCM) setting for a manager customer. # Output only. DoubleClick Campaign Manager (DCM) setting for a manager customer.
        "advertiserId": "A String", # Output only. ID of the Campaign Manager advertiser associated with this customer.
        "networkId": "A String", # Output only. ID of the Campaign Manager network associated with this customer.
        "timeZone": "A String", # Output only. Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.
      },
      "engineId": "A String", # Output only. ID of the account in the external engine account.
      "finalUrlSuffix": "A String", # The URL template for appending params to the final URL.
      "hasPartnersBadge": True or False, # Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
      "id": "A String", # Output only. The ID of the customer.
      "imageAssetAutoMigrationDone": True or False, # Output only. True if feed based image has been migrated to asset based image.
      "imageAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
      "lastModifiedTime": "A String", # Output only. The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
      "localServicesSettings": { # Settings for Local Services customer. # Output only. Settings for Local Services customer.
        "granularInsuranceStatuses": [ # Output only. A read-only list of geo vertical level insurance statuses.
          { # Insurance status at geo + vertical level.
            "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
            "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
            "verificationStatus": "A String", # Output only. Granular insurance status, per geo + vertical.
          },
        ],
        "granularLicenseStatuses": [ # Output only. A read-only list of geo vertical level license statuses.
          { # License status at geo + vertical level.
            "categoryId": "A String", # Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
            "geoCriterionId": "A String", # Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
            "verificationStatus": "A String", # Output only. Granular license status, per geo + vertical.
          },
        ],
      },
      "locationAssetAutoMigrationDone": True or False, # Output only. True if feed based location has been migrated to asset based location.
      "locationAssetAutoMigrationDoneDateTime": "A String", # Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
      "manager": True or False, # Output only. Whether the customer is a manager.
      "managerDescriptiveName": "A String", # Output only. The descriptive name of the manager.
      "managerId": "A String", # Output only. The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.
      "optimizationScore": 3.14, # Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
      "optimizationScoreWeight": 3.14, # Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
      "payPerConversionEligibilityFailureReasons": [ # Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
        "A String",
      ],
      "remarketingSetting": { # Remarketing setting for a customer. # Output only. Remarketing setting for a customer.
        "googleGlobalSiteTag": "A String", # Output only. The Google tag.
      },
      "resourceName": "A String", # Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
      "status": "A String", # Output only. The status of the customer.
      "subManagerDescriptiveName": "A String", # Output only. The descriptive name of the sub manager.
      "subManagerId": "A String", # Output only. The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.
      "testAccount": True or False, # Output only. Whether the customer is a test account.
      "timeZone": "A String", # Immutable. The local timezone ID of the customer.
      "trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL out of parameters.
      "videoBrandSafetySuitability": "A String", # Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
      "videoCustomer": { # Video specific information about a Customer. # Video specific information about a Customer.
        "thirdPartyIntegrationPartners": { # Container for Customer level third party integration partners. # Third Party integration partners.
          "brandLiftIntegrationPartners": [ # Allowed third party integration partners for Brand Lift verification.
            { # Container for third party Brand Lift integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "brandLiftIntegrationPartner": "A String", # Allowed Third Party integration partners for Brand Lift verification.
            },
          ],
          "brandSafetyIntegrationPartners": [ # Allowed third party integration partners for brand safety verification.
            { # Container for third party brand safety integration data for Customer.
              "brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
            },
          ],
          "reachIntegrationPartners": [ # Allowed third party integration partners for reach verification.
            { # Container for third party reach integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "reachIntegrationPartner": "A String", # Allowed Third Party integration partners for reach verification.
            },
          ],
          "viewabilityIntegrationPartners": [ # Allowed third party integration partners for YouTube viewability verification.
            { # Container for third party viewability integration data for Customer.
              "allowShareCost": True or False, # If true, cost data can be shared with this vendor.
              "viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
            },
          ],
        },
      },
    },
    "resourceName": "A String", # Returned for successful operations.
  },
}

removeCampaignAutomaticallyCreatedAsset(customerId, body=None, x__xgafv=None)

Removes automatically created assets from a campaign. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]() [FieldError]() [InternalError]() [MutateError]() [PartialFailureError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer whose assets are being removed. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AutomaticallyCreatedAssetRemovalService.RemoveCampaignAutomaticallyCreatedAsset.
  "operations": [ # Required. The list of operations.
    { # A single operation to remove an automatically created asset from a campaign.
      "asset": "A String", # Required. The resource name of the asset to remove.
      "campaign": "A String", # Required. The resource name of the campaign.
      "fieldType": "A String", # Required. The field type of the asset to remove.
    },
  ],
  "partialFailure": True or False, # Required. If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AutomaticallyCreatedAssetRemovalService.RemoveCampaignAutomaticallyCreatedAsset.
  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to AutomaticallyCreatedAssetRemoval failures in the partial failure mode. Returned when all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), RPC level error will be returned. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
}

searchAudienceInsightsAttributes(customerId, body=None, x__xgafv=None)

Searches for audience attributes that can be used to generate insights. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AudienceInsightsService.ListAudienceInsightsAttributes.
  "customerInsightsGroup": "A String", # The name of the customer being planned for. This is a user-defined value.
  "dimensions": [ # Required. The types of attributes to be returned. Supported dimensions are CATEGORY, KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_LINEUP, AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, .
    "A String",
  ],
  "insightsApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request.
    "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
    "applicationInstance": "A String", # The instance type of the application sending the request.
  },
  "locationCountryFilters": [ # If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and this field is present, then the SUB_COUNTRY_LOCATION attributes returned will be located in these countries. If this field is absent, then location attributes are not filtered by country. Setting this field when SUB_COUNTRY_LOCATION attributes are not requested will return an error.
    { # A location criterion.
      "geoTargetConstant": "A String", # The geo target constant resource name.
    },
  ],
  "queryText": "A String", # Required. A free text query. If the requested dimensions include Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for those dimensions will match or be related to this string. For other dimensions, this field is ignored and all available attributes are returned.
  "youtubeReachLocation": { # A location criterion. # If present, potential YouTube reach estimates within the specified market will be returned for attributes for which they are available. Reach is only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and IN_MARKET_USER_INTEREST dimensions, and may not be available for every attribute of those dimensions in every market.
    "geoTargetConstant": "A String", # The geo target constant resource name.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AudienceInsightsService.ListAudienceInsightsAttributes.
  "attributes": [ # The attributes matching the search query.
    { # An audience attribute, with metadata about it, returned in response to a search.
      "attribute": { # An audience attribute that can be used to request insights about the audience. # The attribute itself.
        "ageRange": { # An age range criterion. # An audience attribute defined by an age range.
          "type": "A String", # Type of the age range.
        },
        "category": { # A Product and Service category. # An audience attribute defined by interest in a Product & Service category.
          "categoryId": "A String", # Required. The criterion ID of the category.
        },
        "device": { # A device criterion. # A device type. (Mobile, Desktop, Tablet)
          "type": "A String", # Type of the device.
        },
        "entity": { # A Knowledge Graph entity, represented by its machine id. # An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
          "knowledgeGraphMachineId": "A String", # Required. The machine ID (mid) of the Knowledge Graph entity.
        },
        "gender": { # A gender criterion. # An audience attribute defined by a gender.
          "type": "A String", # Type of the gender.
        },
        "incomeRange": { # An income range criterion. # A household income percentile range.
          "type": "A String", # Type of the income range.
        },
        "lineup": { # A YouTube Lineup. # A YouTube Lineup.
          "lineupId": "A String", # Required. The numeric ID of the lineup.
        },
        "location": { # A location criterion. # An audience attribute defined by a geographic location.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "parentalStatus": { # A parental status criterion. # A Parental Status value (parent, or not a parent).
          "type": "A String", # Type of the parental status.
        },
        "userInterest": { # Represents a particular interest-based topic to be targeted. # An Affinity or In-Market audience.
          "userInterestCategory": "A String", # The UserInterest resource name.
        },
        "userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # A User List.
          "userList": "A String", # The User List resource name.
        },
        "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
          "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
        },
        "youtubeVideo": { # A YouTube Video criterion. # A YouTube video.
          "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
        },
      },
      "dimension": "A String", # The type of the attribute.
      "displayInfo": "A String", # A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
      "displayName": "A String", # The human-readable name of the attribute.
      "knowledgeGraphAttributeMetadata": { # Metadata associated with a Knowledge Graph Entity attribute. # Special metadata for a Knowledge Graph Entity.
        "entityCapabilities": [ # The capabilities of the entity used in ContentCreatorInsightsService.
          "A String",
        ],
        "relatedCategories": [ # A list of CATEGORY attributes related to this entity.
          # Object with schema name: GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata
        ],
      },
      "lineupAttributeMetadata": { # Metadata associated with a Lineup attribute. # Special metadata for a YouTube Lineup.
        "channelCountLowerBound": "A String", # The lower end of a range containing the number of channels in the lineup.
        "channelCountUpperBound": "A String", # The upper end of a range containing the number of channels in the lineup.
        "inventoryCountry": { # A location criterion. # The national market associated with the lineup.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
        "medianMonthlyInventory": "A String", # The median number of impressions per month on this lineup.
        "sampleChannels": [ # Examples of channels that are included in the lineup.
          { # A YouTube channel returned as an example of the content in a lineup.
            "displayName": "A String", # The name of the sample channel.
            "youtubeChannel": { # A YouTube Channel criterion. # A YouTube channel.
              "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
            },
            "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Metadata for the sample channel.
              "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
            },
          },
        ],
      },
      "locationAttributeMetadata": { # Metadata associated with a Location attribute. # Special metadata for a Location.
        "countryLocation": { # A location criterion. # The country location that this attribute’s sub country location is located in.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      },
      "potentialYoutubeReach": "A String", # An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
      "subscriberShare": 3.14, # The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "userInterestAttributeMetadata": { # Metadata associated with a User Interest attribute. # Special metadata for a User Interest.
        "userInterestDescription": "A String", # English language text description of the user interest category (200 characters max).
      },
      "userListAttributeMetadata": { # Metadata associated with a User List attribute. # Special metadata for a User List.
        "userListType": "A String", # The user list type.
      },
      "viewerShare": 3.14, # The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
      "youtubeChannelMetadata": { # Metadata associated with a YouTube channel attribute. # Special metadata for a YouTube channel.
        "subscriberCount": "A String", # The approximate number of subscribers to the YouTube channel.
      },
      "youtubeVideoMetadata": { # Metadata for a YouTube video attribute. # Special metadata for a YouTube video.
        "commentsCount": "A String", # The total number of comments.
        "likesCount": "A String", # The total number of likes.
        "publishDate": "A String", # The date that the video was created. Formatted as "yyyy-mm-dd".
        "thumbnailUrl": "A String", # The URL of the video thumbnail, prefixed by "https://img.youtube.com/".
        "videoProperties": [ # The properties of this video (such as shorts, live stream).
          "A String",
        ],
        "videoUrl": "A String", # The URL of the video, prefixed by "https://www.youtube.com/".
        "viewsCount": "A String", # The total number of views.
      },
    },
  ],
}

startIdentityVerification(customerId, body=None, x__xgafv=None)

Starts Identity Verification for a given verification program type. Statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The Id of the customer for whom we are creating this verification. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for StartIdentityVerification.
  "verificationProgram": "A String", # Required. The verification program type for which we want to start the verification.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

suggestKeywordThemes(customerId, body=None, x__xgafv=None)

Suggests keyword themes to advertise on.

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SmartCampaignSuggestService.SuggestKeywordThemes.
  "suggestionInfo": { # Information needed to get suggestion for Smart Campaign. More information provided will help the system to derive better suggestions. # Required. Information to get keyword theme suggestions. Required fields: * suggestion_info.final_url * suggestion_info.language_code * suggestion_info.geo_target Recommended fields: * suggestion_info.business_setting
    "adSchedules": [ # Optional. The business ad schedule.
      { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
        "dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
      },
    ],
    "businessContext": { # A context that describes a business. # Optional. Context describing the business to advertise.
      "businessName": "A String", # Optional. The name of the business.
    },
    "businessProfileLocation": "A String", # Optional. The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
    "finalUrl": "A String", # Optional. Landing page URL of the campaign.
    "keywordThemes": [ # Optional. Smart campaign keyword themes. This field may greatly improve suggestion accuracy and we recommend always setting it if possible.
      { # A Smart Campaign keyword theme.
        "freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
        "keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
      },
    ],
    "languageCode": "A String", # Optional. The two letter advertising language for the Smart campaign to be constructed, default to 'en' if not set.
    "locationList": { # A list of locations. # Optional. The targeting geo location by locations.
      "locations": [ # Required. Locations.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
    },
    "proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Optional. The targeting geo location by proximity.
      "address": { # Address for proximity criterion. # Full address.
        "cityName": "A String", # Name of the city.
        "countryCode": "A String", # Country code.
        "postalCode": "A String", # Postal code.
        "provinceCode": "A String", # Province or state code.
        "provinceName": "A String", # Province or state name.
        "streetAddress": "A String", # Street address line 1.
        "streetAddress2": "A String", # Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
      },
      "geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
        "latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
        "longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
      },
      "radius": 3.14, # The radius of the proximity.
      "radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartCampaignSuggestService.SuggestKeywordThemes.
  "keywordThemes": [ # Smart campaign keyword theme suggestions.
    { # A Smart campaign keyword theme suggestion.
      "freeFormKeywordTheme": "A String", # A free-form text keyword theme.
      "keywordThemeConstant": { # A Smart Campaign keyword theme constant. # A Smart campaign keyword theme constant.
        "countryCode": "A String", # Output only. The ISO-3166 Alpha-2 country code of the constant, eg. "US". To display and query matching purpose, the keyword theme needs to be localized.
        "displayName": "A String", # Output only. The display name of the keyword theme or sub keyword theme.
        "languageCode": "A String", # Output only. The ISO-639-1 language code with 2 letters of the constant, eg. "en". To display and query matching purpose, the keyword theme needs to be localized.
        "resourceName": "A String", # Output only. The resource name of the keyword theme constant. Keyword theme constant resource names have the form: `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
      },
    },
  ],
}

suggestSmartCampaignAd(customerId, body=None, x__xgafv=None)

Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SmartCampaignSuggestService.SuggestSmartCampaignAd.
  "suggestionInfo": { # Information needed to get suggestion for Smart Campaign. More information provided will help the system to derive better suggestions. # Required. Inputs used to suggest a Smart campaign ad. Required fields: final_url, language_code, keyword_themes. Optional but recommended fields to improve the quality of the suggestion: business_setting and geo_target.
    "adSchedules": [ # Optional. The business ad schedule.
      { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
        "dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
      },
    ],
    "businessContext": { # A context that describes a business. # Optional. Context describing the business to advertise.
      "businessName": "A String", # Optional. The name of the business.
    },
    "businessProfileLocation": "A String", # Optional. The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
    "finalUrl": "A String", # Optional. Landing page URL of the campaign.
    "keywordThemes": [ # Optional. Smart campaign keyword themes. This field may greatly improve suggestion accuracy and we recommend always setting it if possible.
      { # A Smart Campaign keyword theme.
        "freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
        "keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
      },
    ],
    "languageCode": "A String", # Optional. The two letter advertising language for the Smart campaign to be constructed, default to 'en' if not set.
    "locationList": { # A list of locations. # Optional. The targeting geo location by locations.
      "locations": [ # Required. Locations.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
    },
    "proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Optional. The targeting geo location by proximity.
      "address": { # Address for proximity criterion. # Full address.
        "cityName": "A String", # Name of the city.
        "countryCode": "A String", # Country code.
        "postalCode": "A String", # Postal code.
        "provinceCode": "A String", # Province or state code.
        "provinceName": "A String", # Province or state name.
        "streetAddress": "A String", # Street address line 1.
        "streetAddress2": "A String", # Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
      },
      "geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
        "latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
        "longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
      },
      "radius": 3.14, # The radius of the proximity.
      "radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartCampaignSuggestService.SuggestSmartCampaignAd.
  "adInfo": { # A Smart campaign ad. # Optional. Ad info includes 3 creative headlines and 2 creative descriptions.
    "descriptions": [ # List of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
      { # A text asset used inside an ad.
        "assetPerformanceLabel": "A String", # The performance label of this text asset.
        "pinnedField": "A String", # The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
        "policySummaryInfo": { # Contains policy information for an asset inside an ad. # The policy summary of this text asset.
          "approvalStatus": "A String", # The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.
          "policyTopicEntries": [ # The list of policy findings for this asset.
            { # 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.
              "constraints": [ # Indicates how serving of this resource may be affected (for example, not serving in a country).
                { # Describes the effect on serving that a policy topic entry will have.
                  "certificateDomainMismatchInCountryList": { # A list of countries where a resource's serving is constrained. # Countries where the resource's domain is not covered by the certificates associated with it.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "certificateMissingInCountryList": { # A list of countries where a resource's serving is constrained. # Countries where a certificate is required for serving.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "countryConstraintList": { # A list of countries where a resource's serving is constrained. # Countries where the resource cannot serve.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "resellerConstraint": { # Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
                  },
                },
              ],
              "evidences": [ # Additional information that explains policy finding (for example, the brand name for a trademark finding).
                { # Additional information that explains a policy finding.
                  "destinationMismatch": { # Evidence of mismatches between the URLs of a resource. # Mismatch between the destinations of a resource's URLs.
                    "urlTypes": [ # The set of URLs that did not match each other.
                      "A String",
                    ],
                  },
                  "destinationNotWorking": { # Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices. # Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
                    "device": "A String", # The type of device that failed to load the URL.
                    "dnsErrorType": "A String", # The type of DNS error.
                    "expandedUrl": "A String", # The full URL that didn't work.
                    "httpErrorCode": "A String", # The HTTP error code.
                    "lastCheckedDateTime": "A String", # 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"
                  },
                  "destinationTextList": { # A list of strings found in a destination page that caused a policy finding. # The text in the destination of the resource that is causing a policy finding.
                    "destinationTexts": [ # List of text found in the resource's destination page.
                      "A String",
                    ],
                  },
                  "languageCode": "A String", # The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
                  "textList": { # A list of fragments of text that violated a policy. # List of evidence found in the text of a resource.
                    "texts": [ # The fragments of text from the resource that caused the policy finding.
                      "A String",
                    ],
                  },
                  "websiteList": { # 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. # List of websites linked with this resource.
                    "websites": [ # Websites that caused the policy finding.
                      "A String",
                    ],
                  },
                },
              ],
              "topic": "A String", # 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.
              "type": "A String", # Describes the negative or positive effect this policy will have on serving.
            },
          ],
          "reviewStatus": "A String", # Where in the review process this asset.
        },
        "text": "A String", # Asset text.
      },
    ],
    "headlines": [ # List of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
      { # A text asset used inside an ad.
        "assetPerformanceLabel": "A String", # The performance label of this text asset.
        "pinnedField": "A String", # The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
        "policySummaryInfo": { # Contains policy information for an asset inside an ad. # The policy summary of this text asset.
          "approvalStatus": "A String", # The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.
          "policyTopicEntries": [ # The list of policy findings for this asset.
            { # 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.
              "constraints": [ # Indicates how serving of this resource may be affected (for example, not serving in a country).
                { # Describes the effect on serving that a policy topic entry will have.
                  "certificateDomainMismatchInCountryList": { # A list of countries where a resource's serving is constrained. # Countries where the resource's domain is not covered by the certificates associated with it.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "certificateMissingInCountryList": { # A list of countries where a resource's serving is constrained. # Countries where a certificate is required for serving.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "countryConstraintList": { # A list of countries where a resource's serving is constrained. # Countries where the resource cannot serve.
                    "countries": [ # Countries in which serving is restricted.
                      { # Indicates that a resource's ability to serve in a particular country is constrained.
                        "countryCriterion": "A String", # Geo target constant resource name of the country in which serving is constrained.
                      },
                    ],
                    "totalTargetedCountries": 42, # Total number of countries targeted by the resource.
                  },
                  "resellerConstraint": { # Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
                  },
                },
              ],
              "evidences": [ # Additional information that explains policy finding (for example, the brand name for a trademark finding).
                { # Additional information that explains a policy finding.
                  "destinationMismatch": { # Evidence of mismatches between the URLs of a resource. # Mismatch between the destinations of a resource's URLs.
                    "urlTypes": [ # The set of URLs that did not match each other.
                      "A String",
                    ],
                  },
                  "destinationNotWorking": { # Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices. # Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
                    "device": "A String", # The type of device that failed to load the URL.
                    "dnsErrorType": "A String", # The type of DNS error.
                    "expandedUrl": "A String", # The full URL that didn't work.
                    "httpErrorCode": "A String", # The HTTP error code.
                    "lastCheckedDateTime": "A String", # 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"
                  },
                  "destinationTextList": { # A list of strings found in a destination page that caused a policy finding. # The text in the destination of the resource that is causing a policy finding.
                    "destinationTexts": [ # List of text found in the resource's destination page.
                      "A String",
                    ],
                  },
                  "languageCode": "A String", # The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
                  "textList": { # A list of fragments of text that violated a policy. # List of evidence found in the text of a resource.
                    "texts": [ # The fragments of text from the resource that caused the policy finding.
                      "A String",
                    ],
                  },
                  "websiteList": { # 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. # List of websites linked with this resource.
                    "websites": [ # Websites that caused the policy finding.
                      "A String",
                    ],
                  },
                },
              ],
              "topic": "A String", # 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.
              "type": "A String", # Describes the negative or positive effect this policy will have on serving.
            },
          ],
          "reviewStatus": "A String", # Where in the review process this asset.
        },
        "text": "A String", # Asset text.
      },
    ],
  },
}

suggestSmartCampaignBudgetOptions(customerId, body=None, x__xgafv=None)

Returns BudgetOption suggestions.

Args:
  customerId: string, Required. The ID of the customer whose budget options are to be suggested. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions.
  "campaign": "A String", # Required. The resource name of the campaign to get suggestion for.
  "suggestionInfo": { # Information needed to get suggestion for Smart Campaign. More information provided will help the system to derive better suggestions. # Required. Information needed to get budget options
    "adSchedules": [ # Optional. The business ad schedule.
      { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
        "dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endHour": 42, # Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startHour": 42, # Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
        "startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
      },
    ],
    "businessContext": { # A context that describes a business. # Optional. Context describing the business to advertise.
      "businessName": "A String", # Optional. The name of the business.
    },
    "businessProfileLocation": "A String", # Optional. The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
    "finalUrl": "A String", # Optional. Landing page URL of the campaign.
    "keywordThemes": [ # Optional. Smart campaign keyword themes. This field may greatly improve suggestion accuracy and we recommend always setting it if possible.
      { # A Smart Campaign keyword theme.
        "freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
        "keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
      },
    ],
    "languageCode": "A String", # Optional. The two letter advertising language for the Smart campaign to be constructed, default to 'en' if not set.
    "locationList": { # A list of locations. # Optional. The targeting geo location by locations.
      "locations": [ # Required. Locations.
        { # A location criterion.
          "geoTargetConstant": "A String", # The geo target constant resource name.
        },
      ],
    },
    "proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Optional. The targeting geo location by proximity.
      "address": { # Address for proximity criterion. # Full address.
        "cityName": "A String", # Name of the city.
        "countryCode": "A String", # Country code.
        "postalCode": "A String", # Postal code.
        "provinceCode": "A String", # Province or state code.
        "provinceName": "A String", # Province or state name.
        "streetAddress": "A String", # Street address line 1.
        "streetAddress2": "A String", # Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
      },
      "geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
        "latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
        "longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
      },
      "radius": 3.14, # The radius of the proximity.
      "radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions. Depending on whether the system could suggest the options, either all of the options or none of them might be returned.
  "high": { # Smart Campaign budget option. # Optional. The highest budget option.
    "dailyAmountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
    "metrics": { # Performance metrics for a given budget option. # Metrics pertaining to the suggested budget, could be empty if there is not enough information to derive the estimates.
      "maxDailyClicks": "A String", # The estimated max daily clicks.
      "minDailyClicks": "A String", # The estimated min daily clicks.
    },
  },
  "low": { # Smart Campaign budget option. # Optional. The lowest budget option.
    "dailyAmountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
    "metrics": { # Performance metrics for a given budget option. # Metrics pertaining to the suggested budget, could be empty if there is not enough information to derive the estimates.
      "maxDailyClicks": "A String", # The estimated max daily clicks.
      "minDailyClicks": "A String", # The estimated min daily clicks.
    },
  },
  "recommended": { # Smart Campaign budget option. # Optional. The recommended budget option.
    "dailyAmountMicros": "A String", # The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
    "metrics": { # Performance metrics for a given budget option. # Metrics pertaining to the suggested budget, could be empty if there is not enough information to derive the estimates.
      "maxDailyClicks": "A String", # The estimated max daily clicks.
      "minDailyClicks": "A String", # The estimated min daily clicks.
    },
  },
}

suggestTravelAssets(customerId, body=None, x__xgafv=None)

Returns Travel Asset suggestions. Asset suggestions are returned on a best-effort basis. There are no guarantees that all possible asset types will be returned for any given hotel property.

Args:
  customerId: string, Required. The ID of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for TravelAssetSuggestionService.SuggestTravelAssets.
  "languageOption": "A String", # Required. The language specifications in BCP 47 format (for example, en-US, zh-CN, etc.) for the asset suggestions. Text will be in this language. Usually matches one of the campaign target languages.
  "placeIds": [ # The Google Maps Place IDs of hotels for which assets are requested. See https://developers.google.com/places/web-service/place-id for more information.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for TravelAssetSuggestionService.SuggestTravelAssets.
  "hotelAssetSuggestions": [ # Asset suggestions for each place ID submitted in the request.
    { # Message containing the asset suggestions for a hotel.
      "callToAction": "A String", # Call to action type.
      "finalUrl": "A String", # Suggested final URL for an AssetGroup.
      "hotelName": "A String", # Hotel name in requested language.
      "imageAssets": [ # Image assets such as landscape/portrait/square, etc.
        { # A single image asset suggestion for a hotel.
          "assetFieldType": "A String", # The Image asset type. For example, MARKETING_IMAGE, PORTRAIT_MARKETING_IMAGE, etc.
          "uri": "A String", # URI for the image.
        },
      ],
      "placeId": "A String", # Google Places ID of the hotel.
      "status": "A String", # The status of the hotel asset suggestion.
      "textAssets": [ # Text assets such as headline, description, etc.
        { # A single text asset suggestion for a hotel.
          "assetFieldType": "A String", # The text asset type. For example, HEADLINE, DESCRIPTION, etc.
          "text": "A String", # Asset text in requested language.
        },
      ],
    },
  ],
}

uploadUserData(customerId, body=None, x__xgafv=None)

Uploads the given user data. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [OfflineUserDataJobError]() [QuotaError]() [RequestError]() [UserDataError]()

Args:
  customerId: string, Required. The ID of the customer for which to update the user data. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UserDataService.UploadUserData
  "customerMatchUserListMetadata": { # Metadata for customer match user list. # Metadata for data updates to a Customer Match user list.
    "consent": { # Consent # The consent setting for all the users in this job.
      "adPersonalization": "A String", # This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
      "adUserData": "A String", # This represents consent for ad user data.
    },
    "userList": "A String", # The resource name of remarketing list to update data. Required for job of CUSTOMER_MATCH_USER_LIST type.
  },
  "operations": [ # Required. The list of operations to be done.
    { # Operation to be made for the UploadUserDataRequest.
      "create": { # User data holding user identifiers and attributes. # The list of user data to be appended to the user list.
        "consent": { # Consent # The consent setting for the user. If set, will override the job level consent for this user.
          "adPersonalization": "A String", # This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
          "adUserData": "A String", # This represents consent for ad user data.
        },
        "transactionAttribute": { # Attribute of the store sales transaction. # Additional transactions/attributes associated with the user. Required when updating store sales data.
          "conversionAction": "A String", # The resource name of conversion action to report conversions to. Required.
          "currencyCode": "A String", # Transaction currency code. ISO 4217 three-letter code is used. Required.
          "customValue": "A String", # Value of the custom variable for each transaction. Allowed only if a custom key is provided in the store sales metadata.
          "itemAttribute": { # Item attributes of the transaction. # Item attributes of the transaction. Accessible only to customers on the allow-list.
            "countryCode": "A String", # Common Locale Data Repository (CLDR) territory code of the country associated with the feed where your items are uploaded. See https://developers.google.com/google-ads/api/reference/data/codes-formats#country-codes for more information. This information is useful to differentiate product information in cases where a product (identified by item_id) is associated with multiple countries.
            "itemId": "A String", # A unique identifier of a product. It must be the exact same Merchant Center Item ID you use in your Google Merchant Center for this product. Required.
            "languageCode": "A String", # ISO 639-1 code of the language associated with the feed where your items are uploaded. This information is useful to differentiate product information in cases where a product (identified by item_id) is associated with multiple languages.
            "merchantId": "A String", # ID of the Merchant Center Account. Required.
            "quantity": "A String", # The number of items sold. Defaults to 1 if not set.
          },
          "orderId": "A String", # Transaction order id. Useful to group transactions which are part of the same order.
          "storeAttribute": { # Store attributes of the transaction. # Store attributes of the transaction.
            "storeCode": "A String", # Store code from https://support.google.com/business/answer/3370250#storecode
          },
          "transactionAmountMicros": 3.14, # Transaction amount in micros. Required. Transaction amount in micros needs to be greater than 1000. If item Attributes are provided, it represents the total value of the items, after multiplying the unit price per item by the quantity provided in the ItemAttributes.
          "transactionDateTime": "A String", # Timestamp when transaction occurred. Required. The format is "YYYY-MM-DD HH:MM:SS[+/-HH:MM]", where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30+03:00"
        },
        "userAttribute": { # User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job type. # Additional attributes associated with the user. Required when updating customer match attributes. These have an expiration of 540 days.
          "acquisitionDateTime": "A String", # Timestamp when the user was acquired. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "averagePurchaseCount": 42, # Advertiser defined average number of purchases that are made by the user in a 30 day period.
          "averagePurchaseValueMicros": "A String", # Advertiser defined average purchase value in micros for the user.
          "eventAttribute": [ # Optional. Advertiser defined events and their attributes. All the values in the nested fields are required. Currently this field is in beta.
            { # Advertiser defined events and their attributes. All the values in the nested fields are required.
              "event": "A String", # Required. Advertiser defined event to be used for remarketing. The accepted values are "Viewed", "Cart", "Purchased" and "Recommended".
              "eventDateTime": "A String", # Required. Timestamp at which the event happened. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
              "itemAttribute": [ # Required. Item attributes of the event.
                { # Event Item attributes of the Customer Match.
                  "itemId": "A String", # Optional. A unique identifier of a product. It can be either the Merchant Center Item ID or GTIN (Global Trade Item Number).
                },
              ],
            },
          ],
          "firstPurchaseDateTime": "A String", # Optional. Timestamp of the first purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "lastPurchaseDateTime": "A String", # Timestamp of the last purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "lifecycleStage": "A String", # Optional. Advertiser defined lifecycle stage for the user. The accepted values are "Lead", "Active" and "Churned".
          "lifetimeValueBucket": 42, # Advertiser defined lifetime value bucket for the user. The valid range for a lifetime value bucket is from 1 (low) to 10 (high), except for remove operation where 0 will also be accepted.
          "lifetimeValueMicros": "A String", # Advertiser defined lifetime value for the user.
          "shoppingLoyalty": { # The shopping loyalty related data. Shopping utilizes this data to provide users with a better experience. Accessible only to merchants on the allow-list. # The shopping loyalty related data. Shopping utilizes this data to provide users with a better experience. Accessible only to merchants on the allow-list with the user's consent.
            "loyaltyTier": "A String", # The membership tier. It is a free-form string as each merchant may have their own loyalty system. For example, it could be a number from 1 to 10, or a string such as "Golden" or "Silver", or even empty string "".
          },
        },
        "userIdentifiers": [ # User identification info.
          { # identifying information.
            "addressInfo": { # Address identifier of offline data. # Address information.
              "city": "A String", # City of the address. Only accepted for Store Sales.
              "countryCode": "A String", # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
              "hashedFirstName": "A String", # First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).
              "hashedLastName": "A String", # Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).
              "hashedStreetAddress": "A String", # The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.
              "postalCode": "A String", # Postal code of the user's address.
              "state": "A String", # State code of the address. Only accepted for Store Sales.
            },
            "hashedEmail": "A String", # Hashed email address using SHA-256 hash function after normalization.
            "hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
            "mobileId": "A String", # Mobile device ID (advertising ID/IDFA).
            "thirdPartyUserId": "A String", # Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for
            "userIdentifierSource": "A String", # Source of the user identifier when the upload is from Store Sales
          },
        ],
      },
      "remove": { # User data holding user identifiers and attributes. # The list of user data to be removed from the user list.
        "consent": { # Consent # The consent setting for the user. If set, will override the job level consent for this user.
          "adPersonalization": "A String", # This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
          "adUserData": "A String", # This represents consent for ad user data.
        },
        "transactionAttribute": { # Attribute of the store sales transaction. # Additional transactions/attributes associated with the user. Required when updating store sales data.
          "conversionAction": "A String", # The resource name of conversion action to report conversions to. Required.
          "currencyCode": "A String", # Transaction currency code. ISO 4217 three-letter code is used. Required.
          "customValue": "A String", # Value of the custom variable for each transaction. Allowed only if a custom key is provided in the store sales metadata.
          "itemAttribute": { # Item attributes of the transaction. # Item attributes of the transaction. Accessible only to customers on the allow-list.
            "countryCode": "A String", # Common Locale Data Repository (CLDR) territory code of the country associated with the feed where your items are uploaded. See https://developers.google.com/google-ads/api/reference/data/codes-formats#country-codes for more information. This information is useful to differentiate product information in cases where a product (identified by item_id) is associated with multiple countries.
            "itemId": "A String", # A unique identifier of a product. It must be the exact same Merchant Center Item ID you use in your Google Merchant Center for this product. Required.
            "languageCode": "A String", # ISO 639-1 code of the language associated with the feed where your items are uploaded. This information is useful to differentiate product information in cases where a product (identified by item_id) is associated with multiple languages.
            "merchantId": "A String", # ID of the Merchant Center Account. Required.
            "quantity": "A String", # The number of items sold. Defaults to 1 if not set.
          },
          "orderId": "A String", # Transaction order id. Useful to group transactions which are part of the same order.
          "storeAttribute": { # Store attributes of the transaction. # Store attributes of the transaction.
            "storeCode": "A String", # Store code from https://support.google.com/business/answer/3370250#storecode
          },
          "transactionAmountMicros": 3.14, # Transaction amount in micros. Required. Transaction amount in micros needs to be greater than 1000. If item Attributes are provided, it represents the total value of the items, after multiplying the unit price per item by the quantity provided in the ItemAttributes.
          "transactionDateTime": "A String", # Timestamp when transaction occurred. Required. The format is "YYYY-MM-DD HH:MM:SS[+/-HH:MM]", where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30+03:00"
        },
        "userAttribute": { # User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job type. # Additional attributes associated with the user. Required when updating customer match attributes. These have an expiration of 540 days.
          "acquisitionDateTime": "A String", # Timestamp when the user was acquired. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "averagePurchaseCount": 42, # Advertiser defined average number of purchases that are made by the user in a 30 day period.
          "averagePurchaseValueMicros": "A String", # Advertiser defined average purchase value in micros for the user.
          "eventAttribute": [ # Optional. Advertiser defined events and their attributes. All the values in the nested fields are required. Currently this field is in beta.
            { # Advertiser defined events and their attributes. All the values in the nested fields are required.
              "event": "A String", # Required. Advertiser defined event to be used for remarketing. The accepted values are "Viewed", "Cart", "Purchased" and "Recommended".
              "eventDateTime": "A String", # Required. Timestamp at which the event happened. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
              "itemAttribute": [ # Required. Item attributes of the event.
                { # Event Item attributes of the Customer Match.
                  "itemId": "A String", # Optional. A unique identifier of a product. It can be either the Merchant Center Item ID or GTIN (Global Trade Item Number).
                },
              ],
            },
          ],
          "firstPurchaseDateTime": "A String", # Optional. Timestamp of the first purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "lastPurchaseDateTime": "A String", # Timestamp of the last purchase made by the user. The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default.
          "lifecycleStage": "A String", # Optional. Advertiser defined lifecycle stage for the user. The accepted values are "Lead", "Active" and "Churned".
          "lifetimeValueBucket": 42, # Advertiser defined lifetime value bucket for the user. The valid range for a lifetime value bucket is from 1 (low) to 10 (high), except for remove operation where 0 will also be accepted.
          "lifetimeValueMicros": "A String", # Advertiser defined lifetime value for the user.
          "shoppingLoyalty": { # The shopping loyalty related data. Shopping utilizes this data to provide users with a better experience. Accessible only to merchants on the allow-list. # The shopping loyalty related data. Shopping utilizes this data to provide users with a better experience. Accessible only to merchants on the allow-list with the user's consent.
            "loyaltyTier": "A String", # The membership tier. It is a free-form string as each merchant may have their own loyalty system. For example, it could be a number from 1 to 10, or a string such as "Golden" or "Silver", or even empty string "".
          },
        },
        "userIdentifiers": [ # User identification info.
          { # identifying information.
            "addressInfo": { # Address identifier of offline data. # Address information.
              "city": "A String", # City of the address. Only accepted for Store Sales.
              "countryCode": "A String", # 2-letter country code in ISO-3166-1 alpha-2 of the user's address.
              "hashedFirstName": "A String", # First name of the user, which is hashed as SHA-256 after normalized (Lowercase all characters; Remove any extra spaces before, after, and in between).
              "hashedLastName": "A String", # Last name of the user, which is hashed as SHA-256 after normalized (lower case only and no punctuation).
              "hashedStreetAddress": "A String", # The street address of the user hashed using SHA-256 hash function after normalization (lower case only). Only accepted for ConversionAdjustmentUploadService.
              "postalCode": "A String", # Postal code of the user's address.
              "state": "A String", # State code of the address. Only accepted for Store Sales.
            },
            "hashedEmail": "A String", # Hashed email address using SHA-256 hash function after normalization.
            "hashedPhoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
            "mobileId": "A String", # Mobile device ID (advertising ID/IDFA).
            "thirdPartyUserId": "A String", # Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for
            "userIdentifierSource": "A String", # Source of the user identifier when the upload is from Store Sales
          },
        ],
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for UserDataService.UploadUserData Uploads made through this service will not be visible under the 'Segment members' section for the Customer Match List in the Google Ads UI.
  "receivedOperationsCount": 42, # Number of upload data operations received by API.
  "uploadDateTime": "A String", # The date time at which the request was received by API, formatted as "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
}