class Company(proto.Message):
r"""A Company resource represents a company in the service. A
company is the entity that owns job postings, that is, the
hiring entity responsible for employing applicants for the job
position.
Attributes:
name (str):
Required during company update.
The resource name for a company. This is generated by the
service when a company is created.
The format is
"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}",
for example, "projects/foo/tenants/bar/companies/baz".
If tenant id is unspecified, the default tenant is used. For
example, "projects/foo/companies/bar".
display_name (str):
Required. The display name of the company,
for example, "Google LLC".
external_id (str):
Required. Client side company identifier,
used to uniquely identify the company.
The maximum number of allowed characters is 255.
size (~.common.CompanySize):
The employer's company size.
headquarters_address (str):
The street address of the company's main headquarters, which
may be different from the job location. The service attempts
to geolocate the provided address, and populates a more
specific location wherever possible in
[DerivedInfo.headquarters_location][google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location].
hiring_agency (bool):
Set to true if it is the hiring agency that
post jobs for other employers.
Defaults to false if not provided.
eeo_text (str):
Equal Employment Opportunity legal disclaimer
text to be associated with all jobs, and
typically to be displayed in all roles.
The maximum number of allowed characters is 500.
website_uri (str):
The URI representing the company's primary
web site or home page, for example,
"https://www.google.com".
The maximum number of allowed characters is 255.
career_site_uri (str):
The URI to employer's career site or careers
page on the employer's web site, for example,
"https://careers.google.com".
image_uri (str):
A URI that hosts the employer's company logo.
keyword_searchable_job_custom_attributes (Sequence[str]):
A list of keys of filterable
[Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes],
whose corresponding ``string_values`` are used in keyword
searches. Jobs with ``string_values`` under these specified
field keys are returned if any of the values match the
search keyword. Custom field values with parenthesis,
brackets and special symbols are not searchable as-is, and
those keyword queries must be surrounded by quotes.
derived_info (~.company.Company.DerivedInfo):
Output only. Derived details about the
company.
suspended (bool):
Output only. Indicates whether a company is
flagged to be suspended from public availability
by the service when job content appears
suspicious, abusive, or spammy.
"""
class DerivedInfo(proto.Message):
r"""Derived details about the company.
Attributes:
headquarters_location (~.common.Location):
A structured headquarters location of the company, resolved
from
[Company.headquarters_address][google.cloud.talent.v4beta1.Company.headquarters_address]
if provided.
"""
headquarters_location = proto.Field(
proto.MESSAGE,
number=1,
message=common.Location,
)
name = proto.Field(proto.STRING, number=1)
display_name = proto.Field(proto.STRING, number=2)
external_id = proto.Field(proto.STRING, number=3)
size = proto.Field(
proto.ENUM,
number=4,
enum=common.CompanySize,
)
headquarters_address = proto.Field(proto.STRING, number=5)
hiring_agency = proto.Field(proto.BOOL, number=6)
eeo_text = proto.Field(proto.STRING, number=7)
website_uri = proto.Field(proto.STRING, number=8)
career_site_uri = proto.Field(proto.STRING, number=9)
image_uri = proto.Field(proto.STRING, number=10)
keyword_searchable_job_custom_attributes = proto.RepeatedField(
proto.STRING, number=11)
derived_info = proto.Field(
proto.MESSAGE,
number=12,
message=DerivedInfo,
)
suspended = proto.Field(proto.BOOL, number=13)
class ProductSearchParams(proto.Message):
r"""Parameters for a product search request.
Attributes:
catalog_name (str):
The resource name of the catalog to search.
Format is: ``productSearch/catalogs/CATALOG_NAME``.
category (google.cloud.vision_v1p3beta1.types.ProductSearchCategory):
The category to search in. Optional. It is inferred by the
system if it is not specified. [Deprecated] Use
``product_category``.
product_category (str):
The product category to search in. Optional. It is inferred
by the system if it is not specified. Supported values are
``bag``, ``shoe``, ``sunglasses``, ``dress``, ``outerwear``,
``skirt``, ``top``, ``shorts``, and ``pants``.
normalized_bounding_poly (google.cloud.vision_v1p3beta1.types.NormalizedBoundingPoly):
The bounding polygon around the area of interest in the
image. Optional. If it is not specified, system discretion
will be applied. [Deprecated] Use ``bounding_poly``.
bounding_poly (google.cloud.vision_v1p3beta1.types.BoundingPoly):
The bounding polygon around the area of
interest in the image. Optional. If it is not
specified, system discretion will be applied.
view (google.cloud.vision_v1p3beta1.types.ProductSearchResultsView):
Specifies the verbosity of the product search results.
Optional. Defaults to ``BASIC``.
product_set (str):
The resource name of a
[ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be
searched for similar images.
Format is:
``projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID``.
product_categories (Sequence[str]):
The list of product categories to search in.
Currently, we only consider the first category,
and either "homegoods" or "apparel" should be
specified.
filter (str):
The filtering expression. This can be used to
restrict search results based on Product labels.
We currently support an AND of OR of key-value
expressions, where each expression within an OR
must have the same key.
For example, "(color = red OR color = blue) AND
brand = Google" is acceptable, but not "(color =
red OR brand = Google)" or "color: red".
"""
catalog_name = proto.Field(proto.STRING, number=1)
category = proto.Field(
proto.ENUM,
number=2,
enum="ProductSearchCategory",
)
product_category = proto.Field(proto.STRING, number=5)
normalized_bounding_poly = proto.Field(
proto.MESSAGE,
number=3,
message=geometry.NormalizedBoundingPoly,
)
bounding_poly = proto.Field(
proto.MESSAGE,
number=9,
message=geometry.BoundingPoly,
)
view = proto.Field(
proto.ENUM,
number=4,
enum="ProductSearchResultsView",
)
product_set = proto.Field(proto.STRING, number=6)
product_categories = proto.RepeatedField(proto.STRING, number=7)
filter = proto.Field(proto.STRING, number=8)
class TextAnnotation(proto.Message):
r"""TextAnnotation contains a structured representation of OCR extracted
text. The hierarchy of an OCR extracted text structure is like this:
TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each
structural component, starting from Page, may further have their own
properties. Properties describe detected languages, breaks etc..
Please refer to the
[TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty]
message definition below for more detail.
Attributes:
pages (Sequence[~.text_annotation.Page]):
List of pages detected by OCR.
text (str):
UTF-8 text detected on the pages.
"""
class DetectedLanguage(proto.Message):
r"""Detected language for a structural component.
Attributes:
language_code (str):
The BCP-47 language code, such as "en-US" or "sr-Latn". For
more information, see
http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
confidence (float):
Confidence of detected language. Range [0, 1].
"""
language_code = proto.Field(proto.STRING, number=1)
confidence = proto.Field(proto.FLOAT, number=2)
class DetectedBreak(proto.Message):
r"""Detected start or end of a structural component.
Attributes:
type_ (~.text_annotation.TextAnnotation.DetectedBreak.BreakType):
Detected break type.
is_prefix (bool):
True if break prepends the element.
"""
class BreakType(proto.Enum):
r"""Enum to denote the type of break found. New line, space etc."""
UNKNOWN = 0
SPACE = 1
SURE_SPACE = 2
EOL_SURE_SPACE = 3
HYPHEN = 4
LINE_BREAK = 5
type_ = proto.Field(
proto.ENUM,
number=1,
enum="TextAnnotation.DetectedBreak.BreakType",
)
is_prefix = proto.Field(proto.BOOL, number=2)
class TextProperty(proto.Message):
r"""Additional information detected on the structural component.
Attributes:
detected_languages (Sequence[~.text_annotation.TextAnnotation.DetectedLanguage]):
A list of detected languages together with
confidence.
detected_break (~.text_annotation.TextAnnotation.DetectedBreak):
Detected start or end of a text segment.
"""
detected_languages = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="TextAnnotation.DetectedLanguage",
)
detected_break = proto.Field(
proto.MESSAGE,
number=2,
message="TextAnnotation.DetectedBreak",
)
pages = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="Page",
)
text = proto.Field(proto.STRING, number=2)
class Policy(proto.Message):
r"""A [policy][google.cloud.binaryauthorization.v1beta1.Policy] for
Binary Authorization.
Attributes:
name (str):
Output only. The resource name, in the format
``projects/*/policy``. There is at most one policy per
project.
description (str):
Optional. A descriptive comment.
global_policy_evaluation_mode (google.cloud.binaryauthorization_v1beta1.types.Policy.GlobalPolicyEvaluationMode):
Optional. Controls the evaluation of a
Google-maintained global admission policy for
common system-level images. Images not covered
by the global policy will be subject to the
project admission policy. This setting has no
effect when specified inside a global admission
policy.
admission_whitelist_patterns (Sequence[google.cloud.binaryauthorization_v1beta1.types.AdmissionWhitelistPattern]):
Optional. Admission policy allowlisting. A
matching admission request will always be
permitted. This feature is typically used to
exclude Google or third-party infrastructure
images from Binary Authorization policies.
cluster_admission_rules (Sequence[google.cloud.binaryauthorization_v1beta1.types.Policy.ClusterAdmissionRulesEntry]):
Optional. Per-cluster admission rules. Cluster spec format:
``location.clusterId``. There can be at most one admission
rule per cluster spec. A ``location`` is either a compute
zone (e.g. us-central1-a) or a region (e.g. us-central1).
For ``clusterId`` syntax restrictions see
https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.
kubernetes_namespace_admission_rules (Sequence[google.cloud.binaryauthorization_v1beta1.types.Policy.KubernetesNamespaceAdmissionRulesEntry]):
Optional. Per-kubernetes-namespace admission rules. K8s
namespace spec format: ``[a-z.-]+``, e.g. ``some-namespace``
kubernetes_service_account_admission_rules (Sequence[google.cloud.binaryauthorization_v1beta1.types.Policy.KubernetesServiceAccountAdmissionRulesEntry]):
Optional. Per-kubernetes-service-account admission rules.
Service account spec format: ``namespace:serviceaccount``.
e.g. ``test-ns:default``
istio_service_identity_admission_rules (Sequence[google.cloud.binaryauthorization_v1beta1.types.Policy.IstioServiceIdentityAdmissionRulesEntry]):
Optional. Per-istio-service-identity admission rules. Istio
service identity spec format:
``spiffe://<domain>/ns/<namespace>/sa/<serviceaccount>`` or
``<domain>/ns/<namespace>/sa/<serviceaccount>`` e.g.
``spiffe://example.com/ns/test-ns/sa/default``
default_admission_rule (google.cloud.binaryauthorization_v1beta1.types.AdmissionRule):
Required. Default admission rule for a
cluster without a per-cluster, per-
kubernetes-service-account, or
per-istio-service-identity admission rule.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the policy was last
updated.
"""
class GlobalPolicyEvaluationMode(proto.Enum):
r""""""
GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED = 0
ENABLE = 1
DISABLE = 2
name = proto.Field(
proto.STRING,
number=1,
)
description = proto.Field(
proto.STRING,
number=6,
)
global_policy_evaluation_mode = proto.Field(
proto.ENUM,
number=7,
enum=GlobalPolicyEvaluationMode,
)
admission_whitelist_patterns = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="AdmissionWhitelistPattern",
)
cluster_admission_rules = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=3,
message="AdmissionRule",
)
kubernetes_namespace_admission_rules = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=10,
message="AdmissionRule",
)
kubernetes_service_account_admission_rules = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=8,
message="AdmissionRule",
)
istio_service_identity_admission_rules = proto.MapField(
proto.STRING,
proto.MESSAGE,
number=9,
message="AdmissionRule",
)
default_admission_rule = proto.Field(
proto.MESSAGE,
number=4,
message="AdmissionRule",
)
update_time = proto.Field(
proto.MESSAGE,
number=5,
message=timestamp_pb2.Timestamp,
)
class Campaign(proto.Message):
r"""A campaign.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
resource_name (str):
Immutable. The resource name of the campaign. Campaign
resource names have the form:
``customers/{customer_id}/campaigns/{campaign_id}``
id (int):
Output only. The ID of the campaign.
This field is a member of `oneof`_ ``_id``.
name (str):
The name of the campaign.
This field is required and should not be empty
when creating new campaigns.
It must not contain any null (code point 0x0),
NL line feed (code point 0xA) or carriage return
(code point 0xD) characters.
This field is a member of `oneof`_ ``_name``.
status (google.ads.googleads.v10.enums.types.CampaignStatusEnum.CampaignStatus):
The status of the campaign.
When a new campaign is added, the status
defaults to ENABLED.
serving_status (google.ads.googleads.v10.enums.types.CampaignServingStatusEnum.CampaignServingStatus):
Output only. The ad serving status of the
campaign.
ad_serving_optimization_status (google.ads.googleads.v10.enums.types.AdServingOptimizationStatusEnum.AdServingOptimizationStatus):
The ad serving optimization status of the
campaign.
advertising_channel_type (google.ads.googleads.v10.enums.types.AdvertisingChannelTypeEnum.AdvertisingChannelType):
Immutable. The primary serving target for ads within the
campaign. The targeting options can be refined in
``network_settings``.
This field is required and should not be empty when creating
new campaigns.
Can be set only when creating campaigns. After the campaign
is created, the field can not be changed.
advertising_channel_sub_type (google.ads.googleads.v10.enums.types.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType):
Immutable. Optional refinement to
``advertising_channel_type``. Must be a valid sub-type of
the parent channel type.
Can be set only when creating campaigns. After campaign is
created, the field can not be changed.
tracking_url_template (str):
The URL template for constructing a tracking
URL.
This field is a member of `oneof`_ ``_tracking_url_template``.
url_custom_parameters (Sequence[google.ads.googleads.v10.common.types.CustomParameter]):
The list of mappings used to substitute custom parameter
tags in a ``tracking_url_template``, ``final_urls``, or
``mobile_final_urls``.
real_time_bidding_setting (google.ads.googleads.v10.common.types.RealTimeBiddingSetting):
Settings for Real-Time Bidding, a feature
only available for campaigns targeting the Ad
Exchange network.
network_settings (google.ads.googleads.v10.resources.types.Campaign.NetworkSettings):
The network settings for the campaign.
hotel_setting (google.ads.googleads.v10.resources.types.Campaign.HotelSettingInfo):
Immutable. The hotel setting for the
campaign.
dynamic_search_ads_setting (google.ads.googleads.v10.resources.types.Campaign.DynamicSearchAdsSetting):
The setting for controlling Dynamic Search
Ads (DSA).
shopping_setting (google.ads.googleads.v10.resources.types.Campaign.ShoppingSetting):
The setting for controlling Shopping
campaigns.
targeting_setting (google.ads.googleads.v10.common.types.TargetingSetting):
Setting for targeting related features.
audience_setting (google.ads.googleads.v10.resources.types.Campaign.AudienceSetting):
Immutable. Setting for audience related
features.
This field is a member of `oneof`_ ``_audience_setting``.
geo_target_type_setting (google.ads.googleads.v10.resources.types.Campaign.GeoTargetTypeSetting):
The setting for ads geotargeting.
local_campaign_setting (google.ads.googleads.v10.resources.types.Campaign.LocalCampaignSetting):
The setting for local campaign.
app_campaign_setting (google.ads.googleads.v10.resources.types.Campaign.AppCampaignSetting):
The setting related to App Campaign.
labels (Sequence[str]):
Output only. The resource names of labels
attached to this campaign.
experiment_type (google.ads.googleads.v10.enums.types.CampaignExperimentTypeEnum.CampaignExperimentType):
Output only. The type of campaign: normal,
draft, or experiment.
base_campaign (str):
Output only. The resource name of the base campaign of a
draft or experiment campaign. For base campaigns, this is
equal to ``resource_name``.
This field is read-only.
This field is a member of `oneof`_ ``_base_campaign``.
campaign_budget (str):
The budget of the campaign.
This field is a member of `oneof`_ ``_campaign_budget``.
bidding_strategy_type (google.ads.googleads.v10.enums.types.BiddingStrategyTypeEnum.BiddingStrategyType):
Output only. The type of bidding strategy.
A bidding strategy can be created by setting either the
bidding scheme to create a standard bidding strategy or the
``bidding_strategy`` field to create a portfolio bidding
strategy.
This field is read-only.
accessible_bidding_strategy (str):
Output only. Resource name of AccessibleBiddingStrategy, a
read-only view of the unrestricted attributes of the
attached portfolio bidding strategy identified by
'bidding_strategy'. Empty, if the campaign does not use a
portfolio strategy. Unrestricted strategy attributes are
available to all customers with whom the strategy is shared
and are read from the AccessibleBiddingStrategy resource. In
contrast, restricted attributes are only available to the
owner customer of the strategy and their managers.
Restricted attributes can only be read from the
BiddingStrategy resource.
start_date (str):
The date when campaign started in serving
customer's timezone in YYYY-MM-DD format.
This field is a member of `oneof`_ ``_start_date``.
end_date (str):
The last day of the campaign in serving
customer's timezone in YYYY-MM-DD format.
This field is a member of `oneof`_ ``_end_date``.
final_url_suffix (str):
Suffix used to append query parameters to
landing pages that are served with parallel
tracking.
This field is a member of `oneof`_ ``_final_url_suffix``.
frequency_caps (Sequence[google.ads.googleads.v10.common.types.FrequencyCapEntry]):
A list that limits how often each user will
see this campaign's ads.
video_brand_safety_suitability (google.ads.googleads.v10.enums.types.BrandSafetySuitabilityEnum.BrandSafetySuitability):
Output only. 3-Tier Brand Safety setting for
the campaign.
vanity_pharma (google.ads.googleads.v10.resources.types.Campaign.VanityPharma):
Describes how unbranded pharma ads will be
displayed.
selective_optimization (google.ads.googleads.v10.resources.types.Campaign.SelectiveOptimization):
Selective optimization setting for this
campaign, which includes a set of conversion
actions to optimize this campaign towards.
optimization_goal_setting (google.ads.googleads.v10.resources.types.Campaign.OptimizationGoalSetting):
Optimization goal setting for this campaign,
which includes a set of optimization goal types.
tracking_setting (google.ads.googleads.v10.resources.types.Campaign.TrackingSetting):
Output only. Campaign-level settings for
tracking information.
payment_mode (google.ads.googleads.v10.enums.types.PaymentModeEnum.PaymentMode):
Payment mode for the campaign.
optimization_score (float):
Output only. Optimization score of the
campaign.
Optimization score is an estimate of how well a
campaign is set to perform. It ranges from 0%
(0.0) to 100% (1.0), with 100% indicating that
the campaign is performing at full potential.
This field is null for unscored campaigns.
See "About optimization score" at
https://support.google.com/google-ads/answer/9061546.
This field is read-only.
This field is a member of `oneof`_ ``_optimization_score``.
excluded_parent_asset_field_types (Sequence[google.ads.googleads.v10.enums.types.AssetFieldTypeEnum.AssetFieldType]):
The asset field types that should be excluded
from this campaign. Asset links with these field
types will not be inherited by this campaign
from the upper level.
url_expansion_opt_out (bool):
Represents opting out of URL expansion to
more targeted URLs. If opted out (true), only
the final URLs in the asset group or URLs
specified in the advertiser's Google Merchant
Center or business data feeds are targeted. If
opted in (false), the entire domain will be
targeted. This field can only be set for
Performance Max campaigns, where the default
value is false.
This field is a member of `oneof`_ ``_url_expansion_opt_out``.
bidding_strategy (str):
Portfolio bidding strategy used by campaign.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
commission (google.ads.googleads.v10.common.types.Commission):
Commission is an automatic bidding strategy
in which the advertiser pays a certain portion
of the conversion value.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
manual_cpc (google.ads.googleads.v10.common.types.ManualCpc):
Standard Manual CPC bidding strategy.
Manual click-based bidding where user pays per
click.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
manual_cpm (google.ads.googleads.v10.common.types.ManualCpm):
Standard Manual CPM bidding strategy.
Manual impression-based bidding where user pays
per thousand impressions.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
manual_cpv (google.ads.googleads.v10.common.types.ManualCpv):
Output only. A bidding strategy that pays a
configurable amount per video view.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
maximize_conversions (google.ads.googleads.v10.common.types.MaximizeConversions):
Standard Maximize Conversions bidding
strategy that automatically maximizes number of
conversions while spending your budget.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
maximize_conversion_value (google.ads.googleads.v10.common.types.MaximizeConversionValue):
Standard Maximize Conversion Value bidding
strategy that automatically sets bids to
maximize revenue while spending your budget.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
target_cpa (google.ads.googleads.v10.common.types.TargetCpa):
Standard Target CPA bidding strategy that
automatically sets bids to help get as many
conversions as possible at the target
cost-per-acquisition (CPA) you set.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
target_impression_share (google.ads.googleads.v10.common.types.TargetImpressionShare):
Target Impression Share bidding strategy. An
automated bidding strategy that sets bids to
achieve a desired percentage of impressions.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
target_roas (google.ads.googleads.v10.common.types.TargetRoas):
Standard Target ROAS bidding strategy that
automatically maximizes revenue while averaging
a specific target return on ad spend (ROAS).
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
target_spend (google.ads.googleads.v10.common.types.TargetSpend):
Standard Target Spend bidding strategy that
automatically sets your bids to help get as many
clicks as possible within your budget.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
percent_cpc (google.ads.googleads.v10.common.types.PercentCpc):
Standard Percent Cpc bidding strategy where
bids are a fraction of the advertised price for
some good or service.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
target_cpm (google.ads.googleads.v10.common.types.TargetCpm):
A bidding strategy that automatically
optimizes cost per thousand impressions.
This field is a member of `oneof`_ ``campaign_bidding_strategy``.
"""
class NetworkSettings(proto.Message):
r"""The network settings for the campaign.
Attributes:
target_google_search (bool):
Whether ads will be served with google.com
search results.
This field is a member of `oneof`_ ``_target_google_search``.
target_search_network (bool):
Whether ads will be served on partner sites in the Google
Search Network (requires ``target_google_search`` to also be
``true``).
This field is a member of `oneof`_ ``_target_search_network``.
target_content_network (bool):
Whether ads will be served on specified
placements in the Google Display Network.
Placements are specified using the Placement
criterion.
This field is a member of `oneof`_ ``_target_content_network``.
target_partner_search_network (bool):
Whether ads will be served on the Google
Partner Network. This is available only to some
select Google partner accounts.
This field is a member of `oneof`_ ``_target_partner_search_network``.
"""
target_google_search = proto.Field(
proto.BOOL,
number=5,
optional=True,
)
target_search_network = proto.Field(
proto.BOOL,
number=6,
optional=True,
)
target_content_network = proto.Field(
proto.BOOL,
number=7,
optional=True,
)
target_partner_search_network = proto.Field(
proto.BOOL,
number=8,
optional=True,
)
class HotelSettingInfo(proto.Message):
r"""Campaign-level settings for hotel ads.
Attributes:
hotel_center_id (int):
Immutable. The linked Hotel Center account.
This field is a member of `oneof`_ ``_hotel_center_id``.
"""
hotel_center_id = proto.Field(
proto.INT64,
number=2,
optional=True,
)
class DynamicSearchAdsSetting(proto.Message):
r"""The setting for controlling Dynamic Search Ads (DSA).
Attributes:
domain_name (str):
Required. The Internet domain name that this
setting represents, e.g., "google.com" or
"www.google.com".
language_code (str):
Required. The language code specifying the
language of the domain, e.g., "en".
use_supplied_urls_only (bool):
Whether the campaign uses advertiser supplied
URLs exclusively.
This field is a member of `oneof`_ ``_use_supplied_urls_only``.
feeds (Sequence[str]):
The list of page feeds associated with the
campaign.
"""
domain_name = proto.Field(
proto.STRING,
number=6,
)
language_code = proto.Field(
proto.STRING,
number=7,
)
use_supplied_urls_only = proto.Field(
proto.BOOL,
number=8,
optional=True,
)
feeds = proto.RepeatedField(
proto.STRING,
number=9,
)
class ShoppingSetting(proto.Message):
r"""The setting for Shopping campaigns. Defines the universe of
products that can be advertised by the campaign, and how this
campaign interacts with other Shopping campaigns.
Attributes:
merchant_id (int):
Immutable. ID of the Merchant Center account.
This field is required for create operations.
This field is immutable for Shopping campaigns.
This field is a member of `oneof`_ ``_merchant_id``.
sales_country (str):
Sales country of products to include in the
campaign. This field is required for Shopping
campaigns. This field is optional for
non-Shopping campaigns, but it must be equal to
'ZZ' if set.
This field is a member of `oneof`_ ``_sales_country``.
campaign_priority (int):
Priority of the campaign. Campaigns with
numerically higher priorities take precedence
over those with lower priorities. This field is
required for Shopping campaigns, with values
between 0 and 2, inclusive.
This field is optional for Smart Shopping
campaigns, but must be equal to 3 if set.
This field is a member of `oneof`_ ``_campaign_priority``.
enable_local (bool):
Whether to include local products.
This field is a member of `oneof`_ ``_enable_local``.
use_vehicle_inventory (bool):
Immutable. Whether to target Vehicle Listing
inventory.
"""
merchant_id = proto.Field(
proto.INT64,
number=5,
optional=True,
)
sales_country = proto.Field(
proto.STRING,
number=6,
optional=True,
)
campaign_priority = proto.Field(
proto.INT32,
number=7,
optional=True,
)
enable_local = proto.Field(
proto.BOOL,
number=8,
optional=True,
)
use_vehicle_inventory = proto.Field(
proto.BOOL,
number=9,
)
class TrackingSetting(proto.Message):
r"""Campaign-level settings for tracking information.
Attributes:
tracking_url (str):
Output only. The url used for dynamic
tracking.
This field is a member of `oneof`_ ``_tracking_url``.
"""
tracking_url = proto.Field(
proto.STRING,
number=2,
optional=True,
)
class GeoTargetTypeSetting(proto.Message):
r"""Represents a collection of settings related to ads
geotargeting.
Attributes:
positive_geo_target_type (google.ads.googleads.v10.enums.types.PositiveGeoTargetTypeEnum.PositiveGeoTargetType):
The setting used for positive geotargeting in
this particular campaign.
negative_geo_target_type (google.ads.googleads.v10.enums.types.NegativeGeoTargetTypeEnum.NegativeGeoTargetType):
The setting used for negative geotargeting in
this particular campaign.
"""
positive_geo_target_type = proto.Field(
proto.ENUM,
number=1,
enum=gage_positive_geo_target_type.PositiveGeoTargetTypeEnum.
PositiveGeoTargetType,
)
negative_geo_target_type = proto.Field(
proto.ENUM,
number=2,
enum=gage_negative_geo_target_type.NegativeGeoTargetTypeEnum.
NegativeGeoTargetType,
)
class LocalCampaignSetting(proto.Message):
r"""Campaign setting for local campaigns.
Attributes:
location_source_type (google.ads.googleads.v10.enums.types.LocationSourceTypeEnum.LocationSourceType):
The location source type for this local
campaign.
"""
location_source_type = proto.Field(
proto.ENUM,
number=1,
enum=gage_location_source_type.LocationSourceTypeEnum.
LocationSourceType,
)
class AppCampaignSetting(proto.Message):
r"""Campaign-level settings for App Campaigns.
Attributes:
bidding_strategy_goal_type (google.ads.googleads.v10.enums.types.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType):
Represents the goal which the bidding
strategy of this app campaign should optimize
towards.
app_id (str):
Immutable. A string that uniquely identifies
a mobile application.
This field is a member of `oneof`_ ``_app_id``.
app_store (google.ads.googleads.v10.enums.types.AppCampaignAppStoreEnum.AppCampaignAppStore):
Immutable. The application store that
distributes this specific app.
"""
bidding_strategy_goal_type = proto.Field(
proto.ENUM,
number=1,
enum=app_campaign_bidding_strategy_goal_type.
AppCampaignBiddingStrategyGoalTypeEnum.
AppCampaignBiddingStrategyGoalType,
)
app_id = proto.Field(
proto.STRING,
number=4,
optional=True,
)
app_store = proto.Field(
proto.ENUM,
number=3,
enum=app_campaign_app_store.AppCampaignAppStoreEnum.
AppCampaignAppStore,
)
class VanityPharma(proto.Message):
r"""Describes how unbranded pharma ads will be displayed.
Attributes:
vanity_pharma_display_url_mode (google.ads.googleads.v10.enums.types.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode):
The display mode for vanity pharma URLs.
vanity_pharma_text (google.ads.googleads.v10.enums.types.VanityPharmaTextEnum.VanityPharmaText):
The text that will be displayed in display
URL of the text ad when website description is
the selected display mode for vanity pharma
URLs.
"""
vanity_pharma_display_url_mode = proto.Field(
proto.ENUM,
number=1,
enum=gage_vanity_pharma_display_url_mode.
VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode,
)
vanity_pharma_text = proto.Field(
proto.ENUM,
number=2,
enum=gage_vanity_pharma_text.VanityPharmaTextEnum.VanityPharmaText,
)
class SelectiveOptimization(proto.Message):
r"""Selective optimization setting for this campaign, which
includes a set of conversion actions to optimize this campaign
towards.
Attributes:
conversion_actions (Sequence[str]):
The selected set of conversion actions for
optimizing this campaign.
"""
conversion_actions = proto.RepeatedField(
proto.STRING,
number=2,
)
class OptimizationGoalSetting(proto.Message):
r"""Optimization goal setting for this campaign, which includes a
set of optimization goal types.
Attributes:
optimization_goal_types (Sequence[google.ads.googleads.v10.enums.types.OptimizationGoalTypeEnum.OptimizationGoalType]):
The list of optimization goal types.
"""
optimization_goal_types = proto.RepeatedField(
proto.ENUM,
number=1,
enum=optimization_goal_type.OptimizationGoalTypeEnum.
OptimizationGoalType,
)
class AudienceSetting(proto.Message):
r"""Settings for the audience targeting.
Attributes:
use_audience_grouped (bool):
Immutable. If true, this campaign uses an
Audience resource for audience targeting. If
false, this campaign may use audience segment
criteria instead.
This field is a member of `oneof`_ ``_use_audience_grouped``.
"""
use_audience_grouped = proto.Field(
proto.BOOL,
number=1,
optional=True,
)
resource_name = proto.Field(
proto.STRING,
number=1,
)
id = proto.Field(
proto.INT64,
number=59,
optional=True,
)
name = proto.Field(
proto.STRING,
number=58,
optional=True,
)
status = proto.Field(
proto.ENUM,
number=5,
enum=campaign_status.CampaignStatusEnum.CampaignStatus,
)
serving_status = proto.Field(
proto.ENUM,
number=21,
enum=campaign_serving_status.CampaignServingStatusEnum.
CampaignServingStatus,
)
ad_serving_optimization_status = proto.Field(
proto.ENUM,
number=8,
enum=gage_ad_serving_optimization_status.
AdServingOptimizationStatusEnum.AdServingOptimizationStatus,
)
advertising_channel_type = proto.Field(
proto.ENUM,
number=9,
enum=gage_advertising_channel_type.AdvertisingChannelTypeEnum.
AdvertisingChannelType,
)
advertising_channel_sub_type = proto.Field(
proto.ENUM,
number=10,
enum=gage_advertising_channel_sub_type.AdvertisingChannelSubTypeEnum.
AdvertisingChannelSubType,
)
tracking_url_template = proto.Field(
proto.STRING,
number=60,
optional=True,
)
url_custom_parameters = proto.RepeatedField(
proto.MESSAGE,
number=12,
message=custom_parameter.CustomParameter,
)
real_time_bidding_setting = proto.Field(
proto.MESSAGE,
number=39,
message=gagc_real_time_bidding_setting.RealTimeBiddingSetting,
)
network_settings = proto.Field(
proto.MESSAGE,
number=14,
message=NetworkSettings,
)
hotel_setting = proto.Field(
proto.MESSAGE,
number=32,
message=HotelSettingInfo,
)
dynamic_search_ads_setting = proto.Field(
proto.MESSAGE,
number=33,
message=DynamicSearchAdsSetting,
)
shopping_setting = proto.Field(
proto.MESSAGE,
number=36,
message=ShoppingSetting,
)
targeting_setting = proto.Field(
proto.MESSAGE,
number=43,
message=gagc_targeting_setting.TargetingSetting,
)
audience_setting = proto.Field(
proto.MESSAGE,
number=73,
optional=True,
message=AudienceSetting,
)
geo_target_type_setting = proto.Field(
proto.MESSAGE,
number=47,
message=GeoTargetTypeSetting,
)
local_campaign_setting = proto.Field(
proto.MESSAGE,
number=50,
message=LocalCampaignSetting,
)
app_campaign_setting = proto.Field(
proto.MESSAGE,
number=51,
message=AppCampaignSetting,
)
labels = proto.RepeatedField(
proto.STRING,
number=61,
)
experiment_type = proto.Field(
proto.ENUM,
number=17,
enum=campaign_experiment_type.CampaignExperimentTypeEnum.
CampaignExperimentType,
)
base_campaign = proto.Field(
proto.STRING,
number=56,
optional=True,
)
campaign_budget = proto.Field(
proto.STRING,
number=62,
optional=True,
)
bidding_strategy_type = proto.Field(
proto.ENUM,
number=22,
enum=gage_bidding_strategy_type.BiddingStrategyTypeEnum.
BiddingStrategyType,
)
accessible_bidding_strategy = proto.Field(
proto.STRING,
number=71,
)
start_date = proto.Field(
proto.STRING,
number=63,
optional=True,
)
end_date = proto.Field(
proto.STRING,
number=64,
optional=True,
)
final_url_suffix = proto.Field(
proto.STRING,
number=65,
optional=True,
)
frequency_caps = proto.RepeatedField(
proto.MESSAGE,
number=40,
message=frequency_cap.FrequencyCapEntry,
)
video_brand_safety_suitability = proto.Field(
proto.ENUM,
number=42,
enum=brand_safety_suitability.BrandSafetySuitabilityEnum.
BrandSafetySuitability,
)
vanity_pharma = proto.Field(
proto.MESSAGE,
number=44,
message=VanityPharma,
)
selective_optimization = proto.Field(
proto.MESSAGE,
number=45,
message=SelectiveOptimization,
)
optimization_goal_setting = proto.Field(
proto.MESSAGE,
number=54,
message=OptimizationGoalSetting,
)
tracking_setting = proto.Field(
proto.MESSAGE,
number=46,
message=TrackingSetting,
)
payment_mode = proto.Field(
proto.ENUM,
number=52,
enum=gage_payment_mode.PaymentModeEnum.PaymentMode,
)
optimization_score = proto.Field(
proto.DOUBLE,
number=66,
optional=True,
)
excluded_parent_asset_field_types = proto.RepeatedField(
proto.ENUM,
number=69,
enum=asset_field_type.AssetFieldTypeEnum.AssetFieldType,
)
url_expansion_opt_out = proto.Field(
proto.BOOL,
number=72,
optional=True,
)
bidding_strategy = proto.Field(
proto.STRING,
number=67,
oneof="campaign_bidding_strategy",
)
commission = proto.Field(
proto.MESSAGE,
number=49,
oneof="campaign_bidding_strategy",
message=bidding.Commission,
)
manual_cpc = proto.Field(
proto.MESSAGE,
number=24,
oneof="campaign_bidding_strategy",
message=bidding.ManualCpc,
)
manual_cpm = proto.Field(
proto.MESSAGE,
number=25,
oneof="campaign_bidding_strategy",
message=bidding.ManualCpm,
)
manual_cpv = proto.Field(
proto.MESSAGE,
number=37,
oneof="campaign_bidding_strategy",
message=bidding.ManualCpv,
)
maximize_conversions = proto.Field(
proto.MESSAGE,
number=30,
oneof="campaign_bidding_strategy",
message=bidding.MaximizeConversions,
)
maximize_conversion_value = proto.Field(
proto.MESSAGE,
number=31,
oneof="campaign_bidding_strategy",
message=bidding.MaximizeConversionValue,
)
target_cpa = proto.Field(
proto.MESSAGE,
number=26,
oneof="campaign_bidding_strategy",
message=bidding.TargetCpa,
)
target_impression_share = proto.Field(
proto.MESSAGE,
number=48,
oneof="campaign_bidding_strategy",
message=bidding.TargetImpressionShare,
)
target_roas = proto.Field(
proto.MESSAGE,
number=29,
oneof="campaign_bidding_strategy",
message=bidding.TargetRoas,
)
target_spend = proto.Field(
proto.MESSAGE,
number=27,
oneof="campaign_bidding_strategy",
message=bidding.TargetSpend,
)
percent_cpc = proto.Field(
proto.MESSAGE,
number=34,
oneof="campaign_bidding_strategy",
message=bidding.PercentCpc,
)
target_cpm = proto.Field(
proto.MESSAGE,
number=41,
oneof="campaign_bidding_strategy",
message=bidding.TargetCpm,
)
class CustomJobSpec(proto.Message):
r"""Represents the spec of a CustomJob.
Attributes:
worker_pool_specs (Sequence[google.cloud.aiplatform_v1.types.WorkerPoolSpec]):
Required. The spec of the worker pools
including machine type and Docker image.
scheduling (google.cloud.aiplatform_v1.types.Scheduling):
Scheduling options for a CustomJob.
service_account (str):
Specifies the service account for workload
run-as account. Users submitting jobs must have
act-as permission on this run-as account. If
unspecified, the AI Platform Custom Code Service
Agent for the CustomJob's project is used.
network (str):
The full name of the Compute Engine
`network </compute/docs/networks-and-firewalls#networks>`__
to which the Job should be peered. For example,
``projects/12345/global/networks/myVPC``.
`Format </compute/docs/reference/rest/v1/networks/insert>`__
is of the form
``projects/{project}/global/networks/{network}``. Where
{project} is a project number, as in ``12345``, and
{network} is a network name.
Private services access must already be configured for the
network. If left unspecified, the job is not peered with any
network.
base_output_directory (google.cloud.aiplatform_v1.types.GcsDestination):
The Cloud Storage location to store the output of this
CustomJob or HyperparameterTuningJob. For
HyperparameterTuningJob, the baseOutputDirectory of each
child CustomJob backing a Trial is set to a subdirectory of
name [id][google.cloud.aiplatform.v1.Trial.id] under its
parent HyperparameterTuningJob's baseOutputDirectory.
The following AI Platform environment variables will be
passed to containers or python modules when this field is
set:
For CustomJob:
- AIP_MODEL_DIR = ``<base_output_directory>/model/``
- AIP_CHECKPOINT_DIR =
``<base_output_directory>/checkpoints/``
- AIP_TENSORBOARD_LOG_DIR =
``<base_output_directory>/logs/``
For CustomJob backing a Trial of HyperparameterTuningJob:
- AIP_MODEL_DIR =
``<base_output_directory>/<trial_id>/model/``
- AIP_CHECKPOINT_DIR =
``<base_output_directory>/<trial_id>/checkpoints/``
- AIP_TENSORBOARD_LOG_DIR =
``<base_output_directory>/<trial_id>/logs/``
"""
worker_pool_specs = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="WorkerPoolSpec",
)
scheduling = proto.Field(
proto.MESSAGE,
number=3,
message="Scheduling",
)
service_account = proto.Field(
proto.STRING,
number=4,
)
network = proto.Field(
proto.STRING,
number=5,
)
base_output_directory = proto.Field(
proto.MESSAGE,
number=6,
message=io.GcsDestination,
)
class Instruction(proto.Message):
r"""Instruction of how to perform the labeling task for human
operators. Currently only PDF instruction is supported.
Attributes:
name (str):
Output only. Instruction resource name, format:
projects/{project_id}/instructions/{instruction_id}
display_name (str):
Required. The display name of the
instruction. Maximum of 64 characters.
description (str):
Optional. User-provided description of the
instruction. The description can be up to 10000
characters long.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Creation time of instruction.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Last update time of instruction.
data_type (google.cloud.datalabeling_v1beta1.types.DataType):
Required. The data type of this instruction.
csv_instruction (google.cloud.datalabeling_v1beta1.types.CsvInstruction):
Deprecated: this instruction format is not supported any
more. Instruction from a CSV file, such as for
classification task. The CSV file should have exact two
columns, in the following format:
- The first column is labeled data, such as an image
reference, text.
- The second column is comma separated labels associated
with data.
pdf_instruction (google.cloud.datalabeling_v1beta1.types.PdfInstruction):
Instruction from a PDF document. The PDF
should be in a Cloud Storage bucket.
blocking_resources (Sequence[str]):
Output only. The names of any related
resources that are blocking changes to the
instruction.
"""
name = proto.Field(
proto.STRING,
number=1,
)
display_name = proto.Field(
proto.STRING,
number=2,
)
description = proto.Field(
proto.STRING,
number=3,
)
create_time = proto.Field(
proto.MESSAGE,
number=4,
message=timestamp_pb2.Timestamp,
)
update_time = proto.Field(
proto.MESSAGE,
number=5,
message=timestamp_pb2.Timestamp,
)
data_type = proto.Field(
proto.ENUM,
number=6,
enum=dataset.DataType,
)
csv_instruction = proto.Field(
proto.MESSAGE,
number=7,
message="CsvInstruction",
)
pdf_instruction = proto.Field(
proto.MESSAGE,
number=9,
message="PdfInstruction",
)
blocking_resources = proto.RepeatedField(
proto.STRING,
number=10,
)
class Asset(proto.Message):
r"""Cloud asset. This includes all Google Cloud Platform
resources, Cloud IAM policies, and other non-GCP assets.
Attributes:
name (str):
The full name of the asset. For example:
``//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1``.
See `Resource
Names <https://cloud.google.com/apis/design/resource_names#full_resource_name>`__
for more information.
asset_type (str):
Type of the asset. Example:
"compute.googleapis.com/Disk".
resource (google.cloud.asset_v1p5beta1.types.Resource):
Representation of the resource.
iam_policy (google.iam.v1.policy_pb2.Policy):
Representation of the actual Cloud IAM policy
set on a cloud resource. For each resource,
there must be at most one Cloud IAM policy set
on it.
org_policy (Sequence[google.cloud.orgpolicy.v1.orgpolicy_pb2.Policy]):
Representation of the Cloud Organization
Policy set on an asset. For each asset, there
could be multiple Organization policies with
different constraints.
access_policy (google.identity.accesscontextmanager.v1.access_policy_pb2.AccessPolicy):
access_level (google.identity.accesscontextmanager.v1.access_level_pb2.AccessLevel):
service_perimeter (google.identity.accesscontextmanager.v1.service_perimeter_pb2.ServicePerimeter):
ancestors (Sequence[str]):
Asset's ancestry path in Cloud Resource Manager (CRM)
hierarchy, represented as a list of relative resource names.
Ancestry path starts with the closest CRM ancestor and ends
at root. If the asset is a CRM project/folder/organization,
this starts from the asset itself.
Example: ["projects/123456789", "folders/5432",
"organizations/1234"]
"""
name = proto.Field(
proto.STRING,
number=1,
)
asset_type = proto.Field(
proto.STRING,
number=2,
)
resource = proto.Field(
proto.MESSAGE,
number=3,
message="Resource",
)
iam_policy = proto.Field(
proto.MESSAGE,
number=4,
message=policy_pb2.Policy,
)
org_policy = proto.RepeatedField(
proto.MESSAGE,
number=6,
message=orgpolicy_pb2.Policy,
)
access_policy = proto.Field(
proto.MESSAGE,
number=7,
oneof="access_context_policy",
message=access_policy_pb2.AccessPolicy,
)
access_level = proto.Field(
proto.MESSAGE,
number=8,
oneof="access_context_policy",
message=access_level_pb2.AccessLevel,
)
service_perimeter = proto.Field(
proto.MESSAGE,
number=9,
oneof="access_context_policy",
message=service_perimeter_pb2.ServicePerimeter,
)
ancestors = proto.RepeatedField(
proto.STRING,
number=10,
)
class KeywordPlanCampaign(proto.Message):
r"""A Keyword Plan campaign.
Max number of keyword plan campaigns per plan allowed: 1.
Attributes:
resource_name (str):
Immutable. The resource name of the Keyword Plan campaign.
KeywordPlanCampaign resource names have the form:
``customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}``
keyword_plan (google.protobuf.wrappers_pb2.StringValue):
The keyword plan this campaign belongs to.
id (google.protobuf.wrappers_pb2.Int64Value):
Output only. The ID of the Keyword Plan
campaign.
name (google.protobuf.wrappers_pb2.StringValue):
The name of the Keyword Plan campaign.
This field is required and should not be empty
when creating Keyword Plan campaigns.
language_constants (Sequence[google.protobuf.wrappers_pb2.StringValue]):
The languages targeted for the Keyword Plan
campaign. Max allowed: 1.
keyword_plan_network (google.ads.googleads.v5.enums.types.KeywordPlanNetworkEnum.KeywordPlanNetwork):
Targeting network.
This field is required and should not be empty
when creating Keyword Plan campaigns.
cpc_bid_micros (google.protobuf.wrappers_pb2.Int64Value):
A default max cpc bid in micros, and in the
account currency, for all ad groups under the
campaign.
This field is required and should not be empty
when creating Keyword Plan campaigns.
geo_targets (Sequence[google.ads.googleads.v5.resources.types.KeywordPlanGeoTarget]):
The geo targets.
Max number allowed: 20.
"""
resource_name = proto.Field(
proto.STRING,
number=1,
)
keyword_plan = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers_pb2.StringValue,
)
id = proto.Field(
proto.MESSAGE,
number=3,
message=wrappers_pb2.Int64Value,
)
name = proto.Field(
proto.MESSAGE,
number=4,
message=wrappers_pb2.StringValue,
)
language_constants = proto.RepeatedField(
proto.MESSAGE,
number=5,
message=wrappers_pb2.StringValue,
)
keyword_plan_network = proto.Field(
proto.ENUM,
number=6,
enum=gage_keyword_plan_network.KeywordPlanNetworkEnum.KeywordPlanNetwork,
)
cpc_bid_micros = proto.Field(
proto.MESSAGE,
number=7,
message=wrappers_pb2.Int64Value,
)
geo_targets = proto.RepeatedField(
proto.MESSAGE,
number=8,
message='KeywordPlanGeoTarget',
)
class Recommendation(proto.Message):
r"""A recommendation along with a suggested action. E.g., a
rightsizing recommendation for an underutilized VM, IAM role
recommendations, etc
Attributes:
name (str):
Name of recommendation.
description (str):
Free-form human readable summary in English.
The maximum length is 500 characters.
recommender_subtype (str):
Contains an identifier for a subtype of recommendations
produced for the same recommender. Subtype is a function of
content and impact, meaning a new subtype might be added
when significant changes to ``content`` or
``primary_impact.category`` are introduced. See the
Recommenders section to see a list of subtypes for a given
Recommender.
Examples: For recommender = "google.iam.policy.Recommender",
recommender_subtype can be one of
"REMOVE_ROLE"/"REPLACE_ROLE".
last_refresh_time (google.protobuf.timestamp_pb2.Timestamp):
Last time this recommendation was refreshed
by the system that created it in the first
place.
primary_impact (google.cloud.recommender_v1.types.Impact):
The primary impact that this recommendation
can have while trying to optimize for one
category.
additional_impact (Sequence[google.cloud.recommender_v1.types.Impact]):
Optional set of additional impact that this
recommendation may have when trying to optimize
for the primary category. These may be positive
or negative.
content (google.cloud.recommender_v1.types.RecommendationContent):
Content of the recommendation describing
recommended changes to resources.
state_info (google.cloud.recommender_v1.types.RecommendationStateInfo):
Information for state. Contains state and
metadata.
etag (str):
Fingerprint of the Recommendation. Provides
optimistic locking when updating states.
associated_insights (Sequence[google.cloud.recommender_v1.types.Recommendation.InsightReference]):
Insights that led to this recommendation.
"""
class InsightReference(proto.Message):
r"""Reference to an associated insight.
Attributes:
insight (str):
Insight resource name, e.g.
projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]
"""
insight = proto.Field(proto.STRING, number=1,)
name = proto.Field(proto.STRING, number=1,)
description = proto.Field(proto.STRING, number=2,)
recommender_subtype = proto.Field(proto.STRING, number=12,)
last_refresh_time = proto.Field(
proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,
)
primary_impact = proto.Field(proto.MESSAGE, number=5, message="Impact",)
additional_impact = proto.RepeatedField(proto.MESSAGE, number=6, message="Impact",)
content = proto.Field(proto.MESSAGE, number=7, message="RecommendationContent",)
state_info = proto.Field(
proto.MESSAGE, number=10, message="RecommendationStateInfo",
)
etag = proto.Field(proto.STRING, number=11,)
associated_insights = proto.RepeatedField(
proto.MESSAGE, number=14, message=InsightReference,
)
class TargetCpaOptInRecommendation(proto.Message):
r"""The Target CPA opt-in recommendation.
Attributes:
options (Sequence[google.ads.googleads.v5.resources.types.Recommendation.TargetCpaOptInRecommendation.TargetCpaOptInRecommendationOption]):
Output only. The available goals and
corresponding options for Target CPA strategy.
recommended_target_cpa_micros (google.protobuf.wrappers_pb2.Int64Value):
Output only. The recommended average CPA
target. See required budget amount and impact of
using this recommendation in options list.
"""
class TargetCpaOptInRecommendationOption(proto.Message):
r"""The Target CPA opt-in option with impact estimate.
Attributes:
goal (google.ads.googleads.v5.enums.types.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal):
Output only. The goal achieved by this
option.
target_cpa_micros (google.protobuf.wrappers_pb2.Int64Value):
Output only. Average CPA target.
required_campaign_budget_amount_micros (google.protobuf.wrappers_pb2.Int64Value):
Output only. The minimum campaign budget, in
local currency for the account, required to
achieve the target CPA. Amount is specified in
micros, where one million is equivalent to one
currency unit.
impact (google.ads.googleads.v5.resources.types.Recommendation.RecommendationImpact):
Output only. The impact estimate if this
option is selected.
"""
goal = proto.Field(
proto.ENUM,
number=1,
enum=target_cpa_opt_in_recommendation_goal.
TargetCpaOptInRecommendationGoalEnum.
TargetCpaOptInRecommendationGoal,
)
target_cpa_micros = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers_pb2.Int64Value,
)
required_campaign_budget_amount_micros = proto.Field(
proto.MESSAGE,
number=3,
message=wrappers_pb2.Int64Value,
)
impact = proto.Field(
proto.MESSAGE,
number=4,
message='Recommendation.RecommendationImpact',
)
options = proto.RepeatedField(
proto.MESSAGE,
number=1,
message=
'Recommendation.TargetCpaOptInRecommendation.TargetCpaOptInRecommendationOption',
)
recommended_target_cpa_micros = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers_pb2.Int64Value,
)
class HyperparameterTuningJob(proto.Message):
r"""Represents a HyperparameterTuningJob. A
HyperparameterTuningJob has a Study specification and multiple
CustomJobs with identical CustomJob specification.
Attributes:
name (str):
Output only. Resource name of the
HyperparameterTuningJob.
display_name (str):
Required. The display name of the
HyperparameterTuningJob. The name can be up to
128 characters long and can be consist of any
UTF-8 characters.
study_spec (google.cloud.aiplatform_v1.types.StudySpec):
Required. Study configuration of the
HyperparameterTuningJob.
max_trial_count (int):
Required. The desired total number of Trials.
parallel_trial_count (int):
Required. The desired number of Trials to run
in parallel.
max_failed_trial_count (int):
The number of failed Trials that need to be
seen before failing the HyperparameterTuningJob.
If set to 0, Vertex AI decides how many Trials
must fail before the whole job fails.
trial_job_spec (google.cloud.aiplatform_v1.types.CustomJobSpec):
Required. The spec of a trial job. The same
spec applies to the CustomJobs created in all
the trials.
trials (Sequence[google.cloud.aiplatform_v1.types.Trial]):
Output only. Trials of the
HyperparameterTuningJob.
state (google.cloud.aiplatform_v1.types.JobState):
Output only. The detailed state of the job.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the
HyperparameterTuningJob was created.
start_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the HyperparameterTuningJob for the
first time entered the ``JOB_STATE_RUNNING`` state.
end_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the HyperparameterTuningJob entered
any of the following states: ``JOB_STATE_SUCCEEDED``,
``JOB_STATE_FAILED``, ``JOB_STATE_CANCELLED``.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the
HyperparameterTuningJob was most recently
updated.
error (google.rpc.status_pb2.Status):
Output only. Only populated when job's state is
JOB_STATE_FAILED or JOB_STATE_CANCELLED.
labels (Sequence[google.cloud.aiplatform_v1.types.HyperparameterTuningJob.LabelsEntry]):
The labels with user-defined metadata to
organize HyperparameterTuningJobs.
Label keys and values can be no longer than 64
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed.
See https://goo.gl/xmQnxf for more information
and examples of labels.
encryption_spec (google.cloud.aiplatform_v1.types.EncryptionSpec):
Customer-managed encryption key options for a
HyperparameterTuningJob. If this is set, then
all resources created by the
HyperparameterTuningJob will be encrypted with
the provided encryption key.
"""
name = proto.Field(proto.STRING, number=1,)
display_name = proto.Field(proto.STRING, number=2,)
study_spec = proto.Field(proto.MESSAGE, number=4, message=study.StudySpec,)
max_trial_count = proto.Field(proto.INT32, number=5,)
parallel_trial_count = proto.Field(proto.INT32, number=6,)
max_failed_trial_count = proto.Field(proto.INT32, number=7,)
trial_job_spec = proto.Field(
proto.MESSAGE, number=8, message=custom_job.CustomJobSpec,
)
trials = proto.RepeatedField(proto.MESSAGE, number=9, message=study.Trial,)
state = proto.Field(proto.ENUM, number=10, enum=job_state.JobState,)
create_time = proto.Field(
proto.MESSAGE, number=11, message=timestamp_pb2.Timestamp,
)
start_time = proto.Field(proto.MESSAGE, number=12, message=timestamp_pb2.Timestamp,)
end_time = proto.Field(proto.MESSAGE, number=13, message=timestamp_pb2.Timestamp,)
update_time = proto.Field(
proto.MESSAGE, number=14, message=timestamp_pb2.Timestamp,
)
error = proto.Field(proto.MESSAGE, number=15, message=status_pb2.Status,)
labels = proto.MapField(proto.STRING, proto.STRING, number=16,)
encryption_spec = proto.Field(
proto.MESSAGE, number=17, message=gca_encryption_spec.EncryptionSpec,
)
class WebKeySettings(proto.Message):
r"""Settings specific to keys that can be used by websites.
Attributes:
allow_all_domains (bool):
If set to true, it means allowed_domains will not be
enforced.
allowed_domains (Sequence[str]):
Domains or subdomains of websites allowed to
use the key. All subdomains of an allowed domain
are automatically allowed. A valid domain
requires a host and must not include any path,
port, query or fragment. Examples: 'example.com'
or 'subdomain.example.com'
allow_amp_traffic (bool):
Required. Whether this key can be used on AMP
(Accelerated Mobile Pages) websites.
integration_type (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.IntegrationType):
Required. Describes how this key is
integrated with the website.
challenge_security_preference (google.cloud.recaptchaenterprise_v1.types.WebKeySettings.ChallengeSecurityPreference):
Settings for the frequency and difficulty at
which this key triggers captcha challenges. This
should only be specified for IntegrationTypes
CHECKBOX and INVISIBLE.
"""
class IntegrationType(proto.Enum):
r"""Enum that represents the integration types for web keys."""
INTEGRATION_TYPE_UNSPECIFIED = 0
SCORE = 1
CHECKBOX = 2
INVISIBLE = 3
class ChallengeSecurityPreference(proto.Enum):
r"""Enum that represents the possible challenge frequency and
difficulty configurations for a web key.
"""
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
USABILITY = 1
BALANCE = 2
SECURITY = 3
allow_all_domains = proto.Field(
proto.BOOL,
number=3,
)
allowed_domains = proto.RepeatedField(
proto.STRING,
number=1,
)
allow_amp_traffic = proto.Field(
proto.BOOL,
number=2,
)
integration_type = proto.Field(
proto.ENUM,
number=4,
enum=IntegrationType,
)
challenge_security_preference = proto.Field(
proto.ENUM,
number=5,
enum=ChallengeSecurityPreference,
)
class CompleteQueryRequest(proto.Message):
r"""Auto-complete parameters.
Attributes:
tenant (str):
Required. Resource name of tenant the completion is
performed within.
The format is "projects/{project_id}/tenants/{tenant_id}",
for example, "projects/foo/tenants/bar".
query (str):
Required. The query used to generate
suggestions.
The maximum number of allowed characters is 255.
language_codes (Sequence[str]):
The list of languages of the query. This is the BCP-47
language code, such as "en-US" or "sr-Latn". For more
information, see `Tags for Identifying
Languages <https://tools.ietf.org/html/bcp47>`__.
The maximum number of allowed characters is 255.
page_size (int):
Required. Completion result count.
The maximum allowed page size is 10.
company (str):
If provided, restricts completion to specified company.
The format is
"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}",
for example, "projects/foo/tenants/bar/companies/baz".
scope (google.cloud.talent_v4.types.CompleteQueryRequest.CompletionScope):
The scope of the completion. The defaults is
[CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
type_ (google.cloud.talent_v4.types.CompleteQueryRequest.CompletionType):
The completion topic. The default is
[CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
"""
class CompletionScope(proto.Enum):
r"""Enum to specify the scope of completion."""
COMPLETION_SCOPE_UNSPECIFIED = 0
TENANT = 1
PUBLIC = 2
class CompletionType(proto.Enum):
r"""Enum to specify auto-completion topics."""
COMPLETION_TYPE_UNSPECIFIED = 0
JOB_TITLE = 1
COMPANY_NAME = 2
COMBINED = 3
tenant = proto.Field(
proto.STRING,
number=1,
)
query = proto.Field(
proto.STRING,
number=2,
)
language_codes = proto.RepeatedField(
proto.STRING,
number=3,
)
page_size = proto.Field(
proto.INT32,
number=4,
)
company = proto.Field(
proto.STRING,
number=5,
)
scope = proto.Field(
proto.ENUM,
number=6,
enum=CompletionScope,
)
type_ = proto.Field(
proto.ENUM,
number=7,
enum=CompletionType,
)
class CustomerLicense(proto.Message):
r"""
Attributes:
kind (str):
The type of API resource. This is always
appsmarket#customerLicense.
state (str):
The customer's license status. One of:
- ``ACTIVE``: The customer has a valid license.
- ``UNLICENSED``: There is no license: either this customer
has never installed your application, or else has deleted
it.
application_id (str):
The ID of the application corresponding to
this license query.
editions (Sequence[ccc.hosted.marketplace_v2.types.CustomerLicense.Editions]):
(Deprecated)
id (str):
The ID of the customer license.
customer_id (str):
The domain name of the customer.
"""
class Editions(proto.Message):
r"""
Attributes:
edition_id (str):
(Deprecated)
seat_count (int):
(Deprecated)
assigned_seats (int):
(Deprecated)
"""
edition_id = proto.Field(
proto.STRING,
number=405,
)
seat_count = proto.Field(
proto.INT32,
number=406,
)
assigned_seats = proto.Field(
proto.INT32,
number=409,
)
kind = proto.Field(
proto.STRING,
number=1,
)
state = proto.Field(
proto.STRING,
number=2,
)
application_id = proto.Field(
proto.STRING,
number=3,
)
editions = proto.RepeatedField(
proto.MESSAGE,
number=4,
message=Editions,
)
id = proto.Field(
proto.STRING,
number=101,
)
customer_id = proto.Field(
proto.STRING,
number=102,
)
class GenerateKeywordIdeasRequest(proto.Message):
r"""Request message for
[KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v8.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
Attributes:
customer_id (str):
The ID of the customer with the
recommendation.
language (str):
The resource name of the language to target.
Required
geo_target_constants (Sequence[str]):
The resource names of the location to target.
Max 10
include_adult_keywords (bool):
If true, adult keywords will be included in
response. The default value is false.
page_token (str):
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.
page_size (int):
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.
keyword_plan_network (google.ads.googleads.v8.enums.types.KeywordPlanNetworkEnum.KeywordPlanNetwork):
Targeting network.
keyword_annotation (Sequence[google.ads.googleads.v8.enums.types.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation]):
The keyword annotations to include in
response.
aggregate_metrics (google.ads.googleads.v8.common.types.KeywordPlanAggregateMetrics):
The aggregate fields to include in response.
historical_metrics_options (google.ads.googleads.v8.common.types.HistoricalMetricsOptions):
The options for historical metrics data.
keyword_and_url_seed (google.ads.googleads.v8.services.types.KeywordAndUrlSeed):
A Keyword and a specific Url to generate
ideas from e.g. cars, www.example.com/cars.
keyword_seed (google.ads.googleads.v8.services.types.KeywordSeed):
A Keyword or phrase to generate ideas from,
e.g. cars.
url_seed (google.ads.googleads.v8.services.types.UrlSeed):
A specific url to generate ideas from, e.g.
www.example.com/cars.
site_seed (google.ads.googleads.v8.services.types.SiteSeed):
The site to generate ideas from, e.g.
www.example.com.
"""
customer_id = proto.Field(
proto.STRING,
number=1,
)
language = proto.Field(
proto.STRING,
number=14,
optional=True,
)
geo_target_constants = proto.RepeatedField(
proto.STRING,
number=15,
)
include_adult_keywords = proto.Field(
proto.BOOL,
number=10,
)
page_token = proto.Field(
proto.STRING,
number=12,
)
page_size = proto.Field(
proto.INT32,
number=13,
)
keyword_plan_network = proto.Field(
proto.ENUM,
number=9,
enum=gage_keyword_plan_network.KeywordPlanNetworkEnum.
KeywordPlanNetwork,
)
keyword_annotation = proto.RepeatedField(
proto.ENUM,
number=17,
enum=keyword_plan_keyword_annotation.KeywordPlanKeywordAnnotationEnum.
KeywordPlanKeywordAnnotation,
)
aggregate_metrics = proto.Field(
proto.MESSAGE,
number=16,
message=keyword_plan_common.KeywordPlanAggregateMetrics,
)
historical_metrics_options = proto.Field(
proto.MESSAGE,
number=18,
message=keyword_plan_common.HistoricalMetricsOptions,
)
keyword_and_url_seed = proto.Field(
proto.MESSAGE,
number=2,
oneof='seed',
message='KeywordAndUrlSeed',
)
keyword_seed = proto.Field(
proto.MESSAGE,
number=3,
oneof='seed',
message='KeywordSeed',
)
url_seed = proto.Field(
proto.MESSAGE,
number=5,
oneof='seed',
message='UrlSeed',
)
site_seed = proto.Field(
proto.MESSAGE,
number=11,
oneof='seed',
message='SiteSeed',
)
class SmartCampaignSuggestionInfo(proto.Message):
r"""Information needed to get suggestion for Smart Campaign. More
information provided will help the system to derive better
suggestions.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
final_url (str):
Optional. Landing page URL of the campaign.
language_code (str):
Optional. The two letter advertising language
for the Smart campaign to be constructed,
default to 'en' if not set.
ad_schedules (Sequence[google.ads.googleads.v10.common.types.AdScheduleInfo]):
Optional. The business ad schedule.
keyword_themes (Sequence[google.ads.googleads.v10.common.types.KeywordThemeInfo]):
Optional. Smart campaign keyword themes. This
field may greatly improve suggestion accuracy
and we recommend always setting it if possible.
business_context (google.ads.googleads.v10.services.types.SmartCampaignSuggestionInfo.BusinessContext):
Optional. Context describing the business to
advertise.
This field is a member of `oneof`_ ``business_setting``.
business_location_id (int):
Optional. The ID of the Business Profile location. The
location ID can be fetched by Business Profile API with its
form: accounts/{accountId}/locations/{locationId}. The last
{locationId} component from the Business Profile API
represents the business_location_id. See the [Business
Profile API]
(https://developers.google.com/my-business/reference/rest/v4/accounts.locations)
This field is a member of `oneof`_ ``business_setting``.
location_list (google.ads.googleads.v10.services.types.SmartCampaignSuggestionInfo.LocationList):
Optional. The targeting geo location by
locations.
This field is a member of `oneof`_ ``geo_target``.
proximity (google.ads.googleads.v10.common.types.ProximityInfo):
Optional. The targeting geo location by
proximity.
This field is a member of `oneof`_ ``geo_target``.
"""
class LocationList(proto.Message):
r"""A list of locations.
Attributes:
locations (Sequence[google.ads.googleads.v10.common.types.LocationInfo]):
Required. Locations.
"""
locations = proto.RepeatedField(
proto.MESSAGE,
number=1,
message=criteria.LocationInfo,
)
class BusinessContext(proto.Message):
r"""A context that describes a business.
Attributes:
business_name (str):
Optional. The name of the business.
"""
business_name = proto.Field(
proto.STRING,
number=1,
)
final_url = proto.Field(
proto.STRING,
number=1,
)
language_code = proto.Field(
proto.STRING,
number=3,
)
ad_schedules = proto.RepeatedField(
proto.MESSAGE,
number=6,
message=criteria.AdScheduleInfo,
)
keyword_themes = proto.RepeatedField(
proto.MESSAGE,
number=7,
message=criteria.KeywordThemeInfo,
)
business_context = proto.Field(
proto.MESSAGE,
number=8,
oneof="business_setting",
message=BusinessContext,
)
business_location_id = proto.Field(
proto.INT64,
number=2,
oneof="business_setting",
)
location_list = proto.Field(
proto.MESSAGE,
number=4,
oneof="geo_target",
message=LocationList,
)
proximity = proto.Field(
proto.MESSAGE,
number=5,
oneof="geo_target",
message=criteria.ProximityInfo,
)
class FeedItemAttributeValue(proto.Message):
r"""A feed item attribute value.
Attributes:
feed_attribute_id (google.protobuf.wrappers_pb2.Int64Value):
Id of the feed attribute for which the value
is associated with.
integer_value (google.protobuf.wrappers_pb2.Int64Value):
Int64 value. Should be set if feed_attribute_id refers to a
feed attribute of type INT64.
boolean_value (google.protobuf.wrappers_pb2.BoolValue):
Bool value. Should be set if feed_attribute_id refers to a
feed attribute of type BOOLEAN.
string_value (google.protobuf.wrappers_pb2.StringValue):
String value. Should be set if feed_attribute_id refers to a
feed attribute of type STRING, URL or DATE_TIME. For STRING
the maximum length is 1500 characters. For URL the maximum
length is 2076 characters. For DATE_TIME the string must be
in the format "YYYYMMDD HHMMSS".
double_value (google.protobuf.wrappers_pb2.DoubleValue):
Double value. Should be set if feed_attribute_id refers to a
feed attribute of type DOUBLE.
price_value (google.ads.googleads.v5.common.types.Money):
Price value. Should be set if feed_attribute_id refers to a
feed attribute of type PRICE.
integer_values (Sequence[google.protobuf.wrappers_pb2.Int64Value]):
Repeated int64 value. Should be set if feed_attribute_id
refers to a feed attribute of type INT64_LIST.
boolean_values (Sequence[google.protobuf.wrappers_pb2.BoolValue]):
Repeated bool value. Should be set if feed_attribute_id
refers to a feed attribute of type BOOLEAN_LIST.
string_values (Sequence[google.protobuf.wrappers_pb2.StringValue]):
Repeated string value. Should be set if feed_attribute_id
refers to a feed attribute of type STRING_LIST, URL_LIST or
DATE_TIME_LIST. For STRING_LIST and URL_LIST the total size
of the list in bytes may not exceed 3000. For DATE_TIME_LIST
the number of elements may not exceed 200.
For STRING_LIST the maximum length of each string element is
1500 characters. For URL_LIST the maximum length is 2076
characters. For DATE_TIME the format of the string must be
the same as start and end time for the feed item.
double_values (Sequence[google.protobuf.wrappers_pb2.DoubleValue]):
Repeated double value. Should be set if feed_attribute_id
refers to a feed attribute of type DOUBLE_LIST.
"""
feed_attribute_id = proto.Field(
proto.MESSAGE,
number=1,
message=wrappers.Int64Value,
)
integer_value = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers.Int64Value,
)
boolean_value = proto.Field(
proto.MESSAGE,
number=3,
message=wrappers.BoolValue,
)
string_value = proto.Field(
proto.MESSAGE,
number=4,
message=wrappers.StringValue,
)
double_value = proto.Field(
proto.MESSAGE,
number=5,
message=wrappers.DoubleValue,
)
price_value = proto.Field(
proto.MESSAGE,
number=6,
message=feed_common.Money,
)
integer_values = proto.RepeatedField(
proto.MESSAGE,
number=7,
message=wrappers.Int64Value,
)
boolean_values = proto.RepeatedField(
proto.MESSAGE,
number=8,
message=wrappers.BoolValue,
)
string_values = proto.RepeatedField(
proto.MESSAGE,
number=9,
message=wrappers.StringValue,
)
double_values = proto.RepeatedField(
proto.MESSAGE,
number=10,
message=wrappers.DoubleValue,
)
class StructuredQuery(proto.Message):
r"""A Firestore query.
Attributes:
select (google.cloud.firestore_v1.types.StructuredQuery.Projection):
The projection to return.
from_ (Sequence[google.cloud.firestore_v1.types.StructuredQuery.CollectionSelector]):
The collections to query.
where (google.cloud.firestore_v1.types.StructuredQuery.Filter):
The filter to apply.
order_by (Sequence[google.cloud.firestore_v1.types.StructuredQuery.Order]):
The order to apply to the query results.
Firestore guarantees a stable ordering through the following
rules:
- Any field required to appear in ``order_by``, that is not
already specified in ``order_by``, is appended to the
order in field name order by default.
- If an order on ``__name__`` is not specified, it is
appended by default.
Fields are appended with the same sort direction as the last
order specified, or 'ASCENDING' if no order was specified.
For example:
- ``SELECT * FROM Foo ORDER BY A`` becomes
``SELECT * FROM Foo ORDER BY A, __name__``
- ``SELECT * FROM Foo ORDER BY A DESC`` becomes
``SELECT * FROM Foo ORDER BY A DESC, __name__ DESC``
- ``SELECT * FROM Foo WHERE A > 1`` becomes
``SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__``
start_at (google.cloud.firestore_v1.types.Cursor):
A starting point for the query results.
end_at (google.cloud.firestore_v1.types.Cursor):
A end point for the query results.
offset (int):
The number of results to skip.
Applies before limit, but after all other
constraints. Must be >= 0 if specified.
limit (google.protobuf.wrappers_pb2.Int32Value):
The maximum number of results to return.
Applies after all other constraints.
Must be >= 0 if specified.
"""
class Direction(proto.Enum):
r"""A sort direction."""
DIRECTION_UNSPECIFIED = 0
ASCENDING = 1
DESCENDING = 2
class CollectionSelector(proto.Message):
r"""A selection of a collection, such as ``messages as m1``.
Attributes:
collection_id (str):
The collection ID.
When set, selects only collections with this ID.
all_descendants (bool):
When false, selects only collections that are immediate
children of the ``parent`` specified in the containing
``RunQueryRequest``. When true, selects all descendant
collections.
"""
collection_id = proto.Field(proto.STRING, number=2)
all_descendants = proto.Field(proto.BOOL, number=3)
class Filter(proto.Message):
r"""A filter.
Attributes:
composite_filter (google.cloud.firestore_v1.types.StructuredQuery.CompositeFilter):
A composite filter.
field_filter (google.cloud.firestore_v1.types.StructuredQuery.FieldFilter):
A filter on a document field.
unary_filter (google.cloud.firestore_v1.types.StructuredQuery.UnaryFilter):
A filter that takes exactly one argument.
"""
composite_filter = proto.Field(
proto.MESSAGE,
number=1,
oneof="filter_type",
message="StructuredQuery.CompositeFilter",
)
field_filter = proto.Field(
proto.MESSAGE,
number=2,
oneof="filter_type",
message="StructuredQuery.FieldFilter",
)
unary_filter = proto.Field(
proto.MESSAGE,
number=3,
oneof="filter_type",
message="StructuredQuery.UnaryFilter",
)
class CompositeFilter(proto.Message):
r"""A filter that merges multiple other filters using the given
operator.
Attributes:
op (google.cloud.firestore_v1.types.StructuredQuery.CompositeFilter.Operator):
The operator for combining multiple filters.
filters (Sequence[google.cloud.firestore_v1.types.StructuredQuery.Filter]):
The list of filters to combine.
Must contain at least one filter.
"""
class Operator(proto.Enum):
r"""A composite filter operator."""
OPERATOR_UNSPECIFIED = 0
AND = 1
op = proto.Field(
proto.ENUM,
number=1,
enum="StructuredQuery.CompositeFilter.Operator",
)
filters = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="StructuredQuery.Filter",
)
class FieldFilter(proto.Message):
r"""A filter on a specific field.
Attributes:
field (google.cloud.firestore_v1.types.StructuredQuery.FieldReference):
The field to filter by.
op (google.cloud.firestore_v1.types.StructuredQuery.FieldFilter.Operator):
The operator to filter by.
value (google.cloud.firestore_v1.types.Value):
The value to compare to.
"""
class Operator(proto.Enum):
r"""A field filter operator."""
OPERATOR_UNSPECIFIED = 0
LESS_THAN = 1
LESS_THAN_OR_EQUAL = 2
GREATER_THAN = 3
GREATER_THAN_OR_EQUAL = 4
EQUAL = 5
NOT_EQUAL = 6
ARRAY_CONTAINS = 7
IN = 8
ARRAY_CONTAINS_ANY = 9
NOT_IN = 10
field = proto.Field(
proto.MESSAGE,
number=1,
message="StructuredQuery.FieldReference",
)
op = proto.Field(
proto.ENUM,
number=2,
enum="StructuredQuery.FieldFilter.Operator",
)
value = proto.Field(
proto.MESSAGE,
number=3,
message=document.Value,
)
class UnaryFilter(proto.Message):
r"""A filter with a single operand.
Attributes:
op (google.cloud.firestore_v1.types.StructuredQuery.UnaryFilter.Operator):
The unary operator to apply.
field (google.cloud.firestore_v1.types.StructuredQuery.FieldReference):
The field to which to apply the operator.
"""
class Operator(proto.Enum):
r"""A unary operator."""
OPERATOR_UNSPECIFIED = 0
IS_NAN = 2
IS_NULL = 3
IS_NOT_NAN = 4
IS_NOT_NULL = 5
op = proto.Field(
proto.ENUM,
number=1,
enum="StructuredQuery.UnaryFilter.Operator",
)
field = proto.Field(
proto.MESSAGE,
number=2,
oneof="operand_type",
message="StructuredQuery.FieldReference",
)
class Order(proto.Message):
r"""An order on a field.
Attributes:
field (google.cloud.firestore_v1.types.StructuredQuery.FieldReference):
The field to order by.
direction (google.cloud.firestore_v1.types.StructuredQuery.Direction):
The direction to order by. Defaults to ``ASCENDING``.
"""
field = proto.Field(
proto.MESSAGE,
number=1,
message="StructuredQuery.FieldReference",
)
direction = proto.Field(
proto.ENUM,
number=2,
enum="StructuredQuery.Direction",
)
class FieldReference(proto.Message):
r"""A reference to a field, such as ``max(messages.time) as max_time``.
Attributes:
field_path (str):
"""
field_path = proto.Field(proto.STRING, number=2)
class Projection(proto.Message):
r"""The projection of document's fields to return.
Attributes:
fields (Sequence[google.cloud.firestore_v1.types.StructuredQuery.FieldReference]):
The fields to return.
If empty, all fields are returned. To only return the name
of the document, use ``['__name__']``.
"""
fields = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="StructuredQuery.FieldReference",
)
select = proto.Field(
proto.MESSAGE,
number=1,
message=Projection,
)
from_ = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=CollectionSelector,
)
where = proto.Field(
proto.MESSAGE,
number=3,
message=Filter,
)
order_by = proto.RepeatedField(
proto.MESSAGE,
number=4,
message=Order,
)
start_at = proto.Field(
proto.MESSAGE,
number=7,
message="Cursor",
)
end_at = proto.Field(
proto.MESSAGE,
number=8,
message="Cursor",
)
offset = proto.Field(proto.INT32, number=6)
limit = proto.Field(
proto.MESSAGE,
number=5,
message=wrappers.Int32Value,
)
class FeedItemPlaceholderPolicyInfo(proto.Message):
r"""Policy, validation, and quality approval info for a feed item
for the specified placeholder type.
Attributes:
placeholder_type_enum (google.ads.googleads.v5.enums.types.PlaceholderTypeEnum.PlaceholderType):
Output only. The placeholder type.
feed_mapping_resource_name (google.protobuf.wrappers_pb2.StringValue):
Output only. The FeedMapping that contains
the placeholder type.
review_status (google.ads.googleads.v5.enums.types.PolicyReviewStatusEnum.PolicyReviewStatus):
Output only. Where the placeholder type is in
the review process.
approval_status (google.ads.googleads.v5.enums.types.PolicyApprovalStatusEnum.PolicyApprovalStatus):
Output only. The overall approval status of
the placeholder type, calculated based on the
status of its individual policy topic entries.
policy_topic_entries (Sequence[google.ads.googleads.v5.common.types.PolicyTopicEntry]):
Output only. The list of policy findings for
the placeholder type.
validation_status (google.ads.googleads.v5.enums.types.FeedItemValidationStatusEnum.FeedItemValidationStatus):
Output only. The validation status of the
palceholder type.
validation_errors (Sequence[google.ads.googleads.v5.resources.types.FeedItemValidationError]):
Output only. List of placeholder type
validation errors.
quality_approval_status (google.ads.googleads.v5.enums.types.FeedItemQualityApprovalStatusEnum.FeedItemQualityApprovalStatus):
Output only. Placeholder type quality
evaluation approval status.
quality_disapproval_reasons (Sequence[google.ads.googleads.v5.enums.types.FeedItemQualityDisapprovalReasonEnum.FeedItemQualityDisapprovalReason]):
Output only. List of placeholder type quality
evaluation disapproval reasons.
"""
placeholder_type_enum = proto.Field(
proto.ENUM,
number=10,
enum=placeholder_type.PlaceholderTypeEnum.PlaceholderType,
)
feed_mapping_resource_name = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers.StringValue,
)
review_status = proto.Field(
proto.ENUM,
number=3,
enum=policy_review_status.PolicyReviewStatusEnum.PolicyReviewStatus,
)
approval_status = proto.Field(
proto.ENUM,
number=4,
enum=policy_approval_status.PolicyApprovalStatusEnum.
PolicyApprovalStatus,
)
policy_topic_entries = proto.RepeatedField(
proto.MESSAGE,
number=5,
message=policy.PolicyTopicEntry,
)
validation_status = proto.Field(
proto.ENUM,
number=6,
enum=feed_item_validation_status.FeedItemValidationStatusEnum.
FeedItemValidationStatus,
)
validation_errors = proto.RepeatedField(
proto.MESSAGE,
number=7,
message="FeedItemValidationError",
)
quality_approval_status = proto.Field(
proto.ENUM,
number=8,
enum=feed_item_quality_approval_status.
FeedItemQualityApprovalStatusEnum.FeedItemQualityApprovalStatus,
)
quality_disapproval_reasons = proto.RepeatedField(
proto.ENUM,
number=9,
enum=feed_item_quality_disapproval_reason.
FeedItemQualityDisapprovalReasonEnum.FeedItemQualityDisapprovalReason,
)
class AdmissionRule(proto.Message):
r"""An [admission
rule][google.cloud.binaryauthorization.v1beta1.AdmissionRule]
specifies either that all container images used in a pod creation
request must be attested to by one or more
[attestors][google.cloud.binaryauthorization.v1beta1.Attestor], that
all pod creations will be allowed, or that all pod creations will be
denied.
Images matching an [admission allowlist
pattern][google.cloud.binaryauthorization.v1beta1.AdmissionWhitelistPattern]
are exempted from admission rules and will never block a pod
creation.
Attributes:
evaluation_mode (google.cloud.binaryauthorization_v1beta1.types.AdmissionRule.EvaluationMode):
Required. How this admission rule will be
evaluated.
require_attestations_by (Sequence[str]):
Optional. The resource names of the attestors that must
attest to a container image, in the format
``projects/*/attestors/*``. Each attestor must exist before
a policy can reference it. To add an attestor to a policy
the principal issuing the policy change request must be able
to read the attestor resource.
Note: this field must be non-empty when the evaluation_mode
field specifies REQUIRE_ATTESTATION, otherwise it must be
empty.
enforcement_mode (google.cloud.binaryauthorization_v1beta1.types.AdmissionRule.EnforcementMode):
Required. The action when a pod creation is
denied by the admission rule.
"""
class EvaluationMode(proto.Enum):
r""""""
EVALUATION_MODE_UNSPECIFIED = 0
ALWAYS_ALLOW = 1
REQUIRE_ATTESTATION = 2
ALWAYS_DENY = 3
class EnforcementMode(proto.Enum):
r"""Defines the possible actions when a pod creation is denied by
an admission rule.
"""
ENFORCEMENT_MODE_UNSPECIFIED = 0
ENFORCED_BLOCK_AND_AUDIT_LOG = 1
DRYRUN_AUDIT_LOG_ONLY = 2
evaluation_mode = proto.Field(
proto.ENUM,
number=1,
enum=EvaluationMode,
)
require_attestations_by = proto.RepeatedField(
proto.STRING,
number=2,
)
enforcement_mode = proto.Field(
proto.ENUM,
number=3,
enum=EnforcementMode,
)
class FeedItem(proto.Message):
r"""A feed item.
Attributes:
resource_name (str):
Immutable. The resource name of the feed item. Feed item
resource names have the form:
``customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}``
feed (google.protobuf.wrappers_pb2.StringValue):
Immutable. The feed to which this feed item
belongs.
id (google.protobuf.wrappers_pb2.Int64Value):
Output only. The ID of this feed item.
start_date_time (google.protobuf.wrappers_pb2.StringValue):
Start time in which this feed item is
effective and can begin serving. The time is in
the customer's time zone. The format is "YYYY-
MM-DD HH:MM:SS".
Examples: "2018-03-05 09:15:00" or "2018-02-01
14:34:30".
end_date_time (google.protobuf.wrappers_pb2.StringValue):
End time in which this feed item is no longer
effective and will stop serving. The time is in
the customer's time zone. The format is "YYYY-
MM-DD HH:MM:SS".
Examples: "2018-03-05 09:15:00" or "2018-02-01
14:34:30".
attribute_values (Sequence[google.ads.googleads.v5.resources.types.FeedItemAttributeValue]):
The feed item's attribute values.
geo_targeting_restriction (google.ads.googleads.v5.enums.types.GeoTargetingRestrictionEnum.GeoTargetingRestriction):
Geo targeting restriction specifies the type
of location that can be used for targeting.
url_custom_parameters (Sequence[google.ads.googleads.v5.common.types.CustomParameter]):
The list of mappings used to substitute custom parameter
tags in a ``tracking_url_template``, ``final_urls``, or
``mobile_final_urls``.
status (google.ads.googleads.v5.enums.types.FeedItemStatusEnum.FeedItemStatus):
Output only. Status of the feed item.
This field is read-only.
policy_infos (Sequence[google.ads.googleads.v5.resources.types.FeedItemPlaceholderPolicyInfo]):
Output only. List of info about a feed item's
validation and approval state for active feed
mappings. There will be an entry in the list for
each type of feed mapping associated with the
feed, e.g. a feed with a sitelink and a call
feed mapping would cause every feed item
associated with that feed to have an entry in
this list for both sitelink and call. This field
is read-only.
"""
resource_name = proto.Field(proto.STRING, number=1)
feed = proto.Field(
proto.MESSAGE,
number=2,
message=wrappers.StringValue,
)
id = proto.Field(
proto.MESSAGE,
number=3,
message=wrappers.Int64Value,
)
start_date_time = proto.Field(
proto.MESSAGE,
number=4,
message=wrappers.StringValue,
)
end_date_time = proto.Field(
proto.MESSAGE,
number=5,
message=wrappers.StringValue,
)
attribute_values = proto.RepeatedField(
proto.MESSAGE,
number=6,
message="FeedItemAttributeValue",
)
geo_targeting_restriction = proto.Field(
proto.ENUM,
number=7,
enum=gage_geo_targeting_restriction.GeoTargetingRestrictionEnum.
GeoTargetingRestriction,
)
url_custom_parameters = proto.RepeatedField(
proto.MESSAGE,
number=8,
message=custom_parameter.CustomParameter,
)
status = proto.Field(
proto.ENUM,
number=9,
enum=feed_item_status.FeedItemStatusEnum.FeedItemStatus,
)
policy_infos = proto.RepeatedField(
proto.MESSAGE,
number=10,
message="FeedItemPlaceholderPolicyInfo",
)
class KeywordPlanHistoricalMetrics(proto.Message):
r"""Historical metrics specific to the targeting options
selected. Targeting options include geographies, network, etc.
Refer to https://support.google.com/google-ads/answer/3022575
for more details.
Attributes:
avg_monthly_searches (int):
Approximate number of monthly searches on
this query averaged for the past 12 months.
monthly_search_volumes (Sequence[google.ads.googleads.v8.common.types.MonthlySearchVolume]):
Approximate number of searches on this query
for the past twelve months.
competition (google.ads.googleads.v8.enums.types.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel):
The competition level for the query.
competition_index (int):
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.
low_top_of_page_bid_micros (int):
Top of page bid low range (20th percentile)
in micros for the keyword.
high_top_of_page_bid_micros (int):
Top of page bid high range (80th percentile)
in micros for the keyword.
"""
avg_monthly_searches = proto.Field(
proto.INT64,
number=7,
optional=True,
)
monthly_search_volumes = proto.RepeatedField(
proto.MESSAGE,
number=6,
message='MonthlySearchVolume',
)
competition = proto.Field(
proto.ENUM,
number=2,
enum=keyword_plan_competition_level.KeywordPlanCompetitionLevelEnum.
KeywordPlanCompetitionLevel,
)
competition_index = proto.Field(
proto.INT64,
number=8,
optional=True,
)
low_top_of_page_bid_micros = proto.Field(
proto.INT64,
number=9,
optional=True,
)
high_top_of_page_bid_micros = proto.Field(
proto.INT64,
number=10,
optional=True,
)
class Device(proto.Message):
r"""The device resource.
Attributes:
id (str):
The user-defined device identifier. The
device ID must be unique within a device
registry.
name (str):
The resource path name. For example,
``projects/p1/locations/us-central1/registries/registry0/devices/dev0``
or
``projects/p1/locations/us-central1/registries/registry0/devices/{num_id}``.
When ``name`` is populated as a response from the service,
it always ends in the device numeric ID.
num_id (int):
[Output only] A server-defined unique numeric ID for the
device. This is a more compact way to identify devices, and
it is globally unique.
credentials (Sequence[google.cloud.iot_v1.types.DeviceCredential]):
The credentials used to authenticate this device. To allow
credential rotation without interruption, multiple device
credentials can be bound to this device. No more than 3
credentials can be bound to a single device at a time. When
new credentials are added to a device, they are verified
against the registry credentials. For details, see the
description of the ``DeviceRegistry.credentials`` field.
last_heartbeat_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The last time an MQTT ``PINGREQ`` was
received. This field applies only to devices connecting
through MQTT. MQTT clients usually only send ``PINGREQ``
messages if the connection is idle, and no other messages
have been sent. Timestamps are periodically collected and
written to storage; they may be stale by a few minutes.
last_event_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The last time a telemetry event was received.
Timestamps are periodically collected and written to
storage; they may be stale by a few minutes.
last_state_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The last time a state event was received.
Timestamps are periodically collected and written to
storage; they may be stale by a few minutes.
last_config_ack_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The last time a cloud-to-device config version
acknowledgment was received from the device. This field is
only for configurations sent through MQTT.
last_config_send_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The last time a cloud-to-device config version
was sent to the device.
blocked (bool):
If a device is blocked, connections or
requests from this device will fail. Can be used
to temporarily prevent the device from
connecting if, for example, the sensor is
generating bad data and needs maintenance.
last_error_time (google.protobuf.timestamp_pb2.Timestamp):
[Output only] The time the most recent error occurred, such
as a failure to publish to Cloud Pub/Sub. This field is the
timestamp of 'last_error_status'.
last_error_status (google.rpc.status_pb2.Status):
[Output only] The error message of the most recent error,
such as a failure to publish to Cloud Pub/Sub.
'last_error_time' is the timestamp of this field. If no
errors have occurred, this field has an empty message and
the status code 0 == OK. Otherwise, this field is expected
to have a status code other than OK.
config (google.cloud.iot_v1.types.DeviceConfig):
The most recent device configuration, which is eventually
sent from Cloud IoT Core to the device. If not present on
creation, the configuration will be initialized with an
empty payload and version value of ``1``. To update this
field after creation, use the
``DeviceManager.ModifyCloudToDeviceConfig`` method.
state (google.cloud.iot_v1.types.DeviceState):
[Output only] The state most recently received from the
device. If no state has been reported, this field is not
present.
log_level (google.cloud.iot_v1.types.LogLevel):
**Beta Feature**
The logging verbosity for device activity. If unspecified,
DeviceRegistry.log_level will be used.
metadata (Sequence[google.cloud.iot_v1.types.Device.MetadataEntry]):
The metadata key-value pairs assigned to the device. This
metadata is not interpreted or indexed by Cloud IoT Core. It
can be used to add contextual information for the device.
Keys must conform to the regular expression
[a-zA-Z][a-zA-Z0-9-_.+~%]+ and be less than 128 bytes in
length.
Values are free-form strings. Each value must be less than
or equal to 32 KB in size.
The total size of all keys and values must be less than 256
KB, and the maximum number of key-value pairs is 500.
gateway_config (google.cloud.iot_v1.types.GatewayConfig):
Gateway-related configuration and state.
"""
id = proto.Field(proto.STRING, number=1)
name = proto.Field(proto.STRING, number=2)
num_id = proto.Field(proto.UINT64, number=3)
credentials = proto.RepeatedField(
proto.MESSAGE, number=12, message="DeviceCredential",
)
last_heartbeat_time = proto.Field(
proto.MESSAGE, number=7, message=timestamp.Timestamp,
)
last_event_time = proto.Field(proto.MESSAGE, number=8, message=timestamp.Timestamp,)
last_state_time = proto.Field(
proto.MESSAGE, number=20, message=timestamp.Timestamp,
)
last_config_ack_time = proto.Field(
proto.MESSAGE, number=14, message=timestamp.Timestamp,
)
last_config_send_time = proto.Field(
proto.MESSAGE, number=18, message=timestamp.Timestamp,
)
blocked = proto.Field(proto.BOOL, number=19)
last_error_time = proto.Field(
proto.MESSAGE, number=10, message=timestamp.Timestamp,
)
last_error_status = proto.Field(proto.MESSAGE, number=11, message=status.Status,)
config = proto.Field(proto.MESSAGE, number=13, message="DeviceConfig",)
state = proto.Field(proto.MESSAGE, number=16, message="DeviceState",)
log_level = proto.Field(proto.ENUM, number=21, enum="LogLevel",)
metadata = proto.MapField(proto.STRING, proto.STRING, number=17)
gateway_config = proto.Field(proto.MESSAGE, number=24, message="GatewayConfig",)
class ProductSearchResults(proto.Message):
r"""Results for a product search request.
Attributes:
category (google.cloud.vision_v1p3beta1.types.ProductSearchCategory):
Product category. [Deprecated] Use ``product_category``.
product_category (str):
Product category. Supported values are ``bag`` and ``shoe``.
[Deprecated] ``product_category`` is provided in each
Product.
index_time (google.protobuf.timestamp_pb2.Timestamp):
Timestamp of the index which provided these
results. Changes made after this time are not
reflected in the current results.
products (Sequence[google.cloud.vision_v1p3beta1.types.ProductSearchResults.ProductInfo]):
List of detected products.
results (Sequence[google.cloud.vision_v1p3beta1.types.ProductSearchResults.Result]):
List of results, one for each product match.
"""
class ProductInfo(proto.Message):
r"""Information about a product.
Attributes:
product_id (str):
Product ID.
image_uri (str):
The URI of the image which matched the query image.
This field is returned only if ``view`` is set to ``FULL``
in the request.
score (float):
A confidence level on the match, ranging from 0 (no
confidence) to 1 (full confidence).
This field is returned only if ``view`` is set to ``FULL``
in the request.
"""
product_id = proto.Field(proto.STRING, number=1)
image_uri = proto.Field(proto.STRING, number=2)
score = proto.Field(proto.FLOAT, number=3)
class Result(proto.Message):
r"""Information about a product.
Attributes:
product (google.cloud.vision_v1p3beta1.types.Product):
The Product.
score (float):
A confidence level on the match, ranging from 0 (no
confidence) to 1 (full confidence).
This field is returned only if ``view`` is set to ``FULL``
in the request.
image (str):
The resource name of the image from the
product that is the closest match to the query.
"""
product = proto.Field(
proto.MESSAGE,
number=1,
message=product_search_service.Product,
)
score = proto.Field(proto.FLOAT, number=2)
image = proto.Field(proto.STRING, number=3)
category = proto.Field(
proto.ENUM,
number=1,
enum="ProductSearchCategory",
)
product_category = proto.Field(proto.STRING, number=4)
index_time = proto.Field(
proto.MESSAGE,
number=2,
message=timestamp.Timestamp,
)
products = proto.RepeatedField(
proto.MESSAGE,
number=3,
message=ProductInfo,
)
results = proto.RepeatedField(
proto.MESSAGE,
number=5,
message=Result,
)
class DeviceRegistry(proto.Message):
r"""A container for a group of devices.
Attributes:
id (str):
The identifier of this device registry. For example,
``myRegistry``.
name (str):
The resource path name. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
event_notification_configs (Sequence[google.cloud.iot_v1.types.EventNotificationConfig]):
The configuration for notification of
telemetry events received from the device. All
telemetry events that were successfully
published by the device and acknowledged by
Cloud IoT Core are guaranteed to be delivered to
Cloud Pub/Sub. If multiple configurations match
a message, only the first matching configuration
is used. If you try to publish a device
telemetry event using MQTT without specifying a
Cloud Pub/Sub topic for the device's registry,
the connection closes automatically. If you try
to do so using an HTTP connection, an error is
returned. Up to 10 configurations may be
provided.
state_notification_config (google.cloud.iot_v1.types.StateNotificationConfig):
The configuration for notification of new
states received from the device. State updates
are guaranteed to be stored in the state
history, but notifications to Cloud Pub/Sub are
not guaranteed. For example, if permissions are
misconfigured or the specified topic doesn't
exist, no notification will be published but the
state will still be stored in Cloud IoT Core.
mqtt_config (google.cloud.iot_v1.types.MqttConfig):
The MQTT configuration for this device
registry.
http_config (google.cloud.iot_v1.types.HttpConfig):
The DeviceService (HTTP) configuration for
this device registry.
log_level (google.cloud.iot_v1.types.LogLevel):
**Beta Feature**
The default logging verbosity for activity from devices in
this registry. The verbosity level can be overridden by
Device.log_level.
credentials (Sequence[google.cloud.iot_v1.types.RegistryCredential]):
The credentials used to verify the device
credentials. No more than 10 credentials can be
bound to a single registry at a time. The
verification process occurs at the time of
device creation or update. If this field is
empty, no verification is performed. Otherwise,
the credentials of a newly created device or
added credentials of an updated device should be
signed with one of these registry credentials.
Note, however, that existing devices will never
be affected by modifications to this list of
credentials: after a device has been
successfully created in a registry, it should be
able to connect even if its registry credentials
are revoked, deleted, or modified.
"""
id = proto.Field(proto.STRING, number=1)
name = proto.Field(proto.STRING, number=2)
event_notification_configs = proto.RepeatedField(
proto.MESSAGE, number=10, message="EventNotificationConfig",
)
state_notification_config = proto.Field(
proto.MESSAGE, number=7, message="StateNotificationConfig",
)
mqtt_config = proto.Field(proto.MESSAGE, number=4, message="MqttConfig",)
http_config = proto.Field(proto.MESSAGE, number=9, message="HttpConfig",)
log_level = proto.Field(proto.ENUM, number=11, enum="LogLevel",)
credentials = proto.RepeatedField(
proto.MESSAGE, number=8, message="RegistryCredential",
)
class Block(proto.Message):
r"""Logical element on the page.
Attributes:
property (~.text_annotation.TextAnnotation.TextProperty):
Additional information detected for the
block.
bounding_box (~.geometry.BoundingPoly):
The bounding box for the block. The vertices are in the
order of top-left, top-right, bottom-right, bottom-left.
When a rotation of the bounding box is detected the rotation
is represented as around the top-left corner as defined when
the text is read in the 'natural' orientation. For example:
- when the text is horizontal it might look like:
::
0----1
| |
3----2
- when it's rotated 180 degrees around the top-left corner
it becomes:
::
2----3
| |
1----0
and the vertex order will still be (0, 1, 2, 3).
paragraphs (Sequence[~.text_annotation.Paragraph]):
List of paragraphs in this block (if this
blocks is of type text).
block_type (~.text_annotation.Block.BlockType):
Detected block type (text, image etc) for
this block.
confidence (float):
Confidence of the OCR results on the block. Range [0, 1].
"""
class BlockType(proto.Enum):
r"""Type of a block (text, image etc) as identified by OCR."""
UNKNOWN = 0
TEXT = 1
TABLE = 2
PICTURE = 3
RULER = 4
BARCODE = 5
property = proto.Field(
proto.MESSAGE,
number=1,
message=TextAnnotation.TextProperty,
)
bounding_box = proto.Field(
proto.MESSAGE,
number=2,
message=geometry.BoundingPoly,
)
paragraphs = proto.RepeatedField(
proto.MESSAGE,
number=3,
message="Paragraph",
)
block_type = proto.Field(
proto.ENUM,
number=4,
enum=BlockType,
)
confidence = proto.Field(proto.FLOAT, number=5)
class LicenseNotification(proto.Message):
r"""
Attributes:
id (str):
The ID of the license notification.
application_id (str):
The ID of the application according to this
notification.
timestamp (int):
The time the event occurred, measuring in
milliseconds since the UNIX epoch.
customer_id (str):
The domain name of the customer corresponding
to this notification.
kind (str):
The type of API resource. This is always
appsmarket#licenseNotification.
provisions (Sequence[ccc.hosted.marketplace_v2.types.LicenseNotification.Provisions]):
The list of provisioning notifications.
expiries (Sequence[ccc.hosted.marketplace_v2.types.LicenseNotification.Expiries]):
The list of expiry notifications.
reassignments (Sequence[ccc.hosted.marketplace_v2.types.LicenseNotification.Reassignments]):
The list of reassignment notifications.
deletes (Sequence[ccc.hosted.marketplace_v2.types.LicenseNotification.Deletes]):
The list of deletion notifications.
"""
class Deletes(proto.Message):
r"""
Attributes:
kind (str):
edition_id (str):
(Deprecated)
"""
kind = proto.Field(
proto.STRING,
number=1,
)
edition_id = proto.Field(
proto.STRING,
number=901,
)
class Expiries(proto.Message):
r"""
Attributes:
kind (str):
edition_id (str):
(Deprecated)
"""
kind = proto.Field(
proto.STRING,
number=1,
)
edition_id = proto.Field(
proto.STRING,
number=701,
)
class Provisions(proto.Message):
r"""
Attributes:
kind (str):
edition_id (str):
(Deprecated)
seat_count (int):
The number of seats that were provisioned.
"""
kind = proto.Field(
proto.STRING,
number=1,
)
edition_id = proto.Field(
proto.STRING,
number=601,
)
seat_count = proto.Field(
proto.INT64,
number=602,
)
class Reassignments(proto.Message):
r"""
Attributes:
kind (str):
user_id (str):
The email address of the reassigned user.
type_ (str):
edition_id (str):
(Deprecated)
"""
kind = proto.Field(
proto.STRING,
number=1,
)
user_id = proto.Field(
proto.STRING,
number=801,
)
type_ = proto.Field(
proto.STRING,
number=802,
)
edition_id = proto.Field(
proto.STRING,
number=803,
)
id = proto.Field(
proto.STRING,
number=1,
)
application_id = proto.Field(
proto.STRING,
number=2,
)
timestamp = proto.Field(
proto.INT64,
number=3,
)
customer_id = proto.Field(
proto.STRING,
number=4,
)
kind = proto.Field(
proto.STRING,
number=5,
)
provisions = proto.RepeatedField(
proto.MESSAGE,
number=6,
message=Provisions,
)
expiries = proto.RepeatedField(
proto.MESSAGE,
number=7,
message=Expiries,
)
reassignments = proto.RepeatedField(
proto.MESSAGE,
number=8,
message=Reassignments,
)
deletes = proto.RepeatedField(
proto.MESSAGE,
number=9,
message=Deletes,
)
class PolicyTag(proto.Message):
r"""Denotes one policy tag in a taxonomy, for example, SSN.
Policy tags can be defined in a hierarchy. For example:
::
+ Geolocation
+ LatLong
+ City
+ ZipCode
Where the "Geolocation" policy tag contains three children.
Attributes:
name (str):
Output only. Resource name of this policy tag
in the URL format.
The policy tag manager generates unique taxonomy
IDs and policy tag IDs.<br /><br />
display_name (str):
Required. User-defined name of this policy
tag.
The name can't start or end with spaces and must
be unique within the parent taxonomy, contain
only Unicode letters, numbers, underscores,
dashes and spaces, and be at most 200 bytes long
when encoded in UTF-8.
description (str):
Description of this policy tag. If not set,
defaults to empty.
The description must contain only Unicode
characters, tabs, newlines, carriage returns and
page breaks, and be at most 2000 bytes long when
encoded in UTF-8.
parent_policy_tag (str):
Resource name of this policy tag's parent
policy tag. If empty, this is a top level tag.
If not set, defaults to an empty string.
For example, for the "LatLong" policy tag in the
example above, this field contains the resource
name of the "Geolocation" policy tag, and, for
"Geolocation", this field is empty.
child_policy_tags (Sequence[str]):
Output only. Resource names of child policy
tags of this policy tag.
"""
name = proto.Field(
proto.STRING,
number=1,
)
display_name = proto.Field(
proto.STRING,
number=2,
)
description = proto.Field(
proto.STRING,
number=3,
)
parent_policy_tag = proto.Field(
proto.STRING,
number=4,
)
child_policy_tags = proto.RepeatedField(
proto.STRING,
number=5,
)
class DataLabelingJob(proto.Message):
r"""DataLabelingJob is used to trigger a human labeling job on
unlabeled data from the following Dataset:
Attributes:
name (str):
Output only. Resource name of the
DataLabelingJob.
display_name (str):
Required. The user-defined name of the
DataLabelingJob. The name can be up to 128
characters long and can be consist of any UTF-8
characters.
Display name of a DataLabelingJob.
datasets (Sequence[str]):
Required. Dataset resource names. Right now we only support
labeling from a single Dataset. Format:
``projects/{project}/locations/{location}/datasets/{dataset}``
annotation_labels (Sequence[google.cloud.aiplatform_v1.types.DataLabelingJob.AnnotationLabelsEntry]):
Labels to assign to annotations generated by
this DataLabelingJob.
Label keys and values can be no longer than 64
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. See https://goo.gl/xmQnxf for more
information and examples of labels. System
reserved label keys are prefixed with
"aiplatform.googleapis.com/" and are immutable.
labeler_count (int):
Required. Number of labelers to work on each
DataItem.
instruction_uri (str):
Required. The Google Cloud Storage location
of the instruction pdf. This pdf is shared with
labelers, and provides detailed description on
how to label DataItems in Datasets.
inputs_schema_uri (str):
Required. Points to a YAML file stored on
Google Cloud Storage describing the config for a
specific type of DataLabelingJob. The schema
files that can be used here are found in the
https://storage.googleapis.com/google-cloud-aiplatform
bucket in the /schema/datalabelingjob/inputs/
folder.
inputs (google.protobuf.struct_pb2.Value):
Required. Input config parameters for the
DataLabelingJob.
state (google.cloud.aiplatform_v1.types.JobState):
Output only. The detailed state of the job.
labeling_progress (int):
Output only. Current labeling job progress percentage scaled
in interval [0, 100], indicating the percentage of DataItems
that has been finished.
current_spend (google.type.money_pb2.Money):
Output only. Estimated cost(in US dollars)
that the DataLabelingJob has incurred to date.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Timestamp when this
DataLabelingJob was created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Timestamp when this
DataLabelingJob was updated most recently.
error (google.rpc.status_pb2.Status):
Output only. DataLabelingJob errors. It is only populated
when job's state is ``JOB_STATE_FAILED`` or
``JOB_STATE_CANCELLED``.
labels (Sequence[google.cloud.aiplatform_v1.types.DataLabelingJob.LabelsEntry]):
The labels with user-defined metadata to organize your
DataLabelingJobs.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters,
numeric characters, underscores and dashes. International
characters are allowed.
See https://goo.gl/xmQnxf for more information and examples
of labels. System reserved label keys are prefixed with
"aiplatform.googleapis.com/" and are immutable. Following
system labels exist for each DataLabelingJob:
- "aiplatform.googleapis.com/schema": output only, its
value is the
[inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
title.
specialist_pools (Sequence[str]):
The SpecialistPools' resource names
associated with this job.
encryption_spec (google.cloud.aiplatform_v1.types.EncryptionSpec):
Customer-managed encryption key spec for a
DataLabelingJob. If set, this DataLabelingJob
will be secured by this key.
Note: Annotations created in the DataLabelingJob
are associated with the EncryptionSpec of the
Dataset they are exported to.
active_learning_config (google.cloud.aiplatform_v1.types.ActiveLearningConfig):
Parameters that configure the active learning
pipeline. Active learning will label the data
incrementally via several iterations. For every
iteration, it will select a batch of data based
on the sampling strategy.
"""
name = proto.Field(
proto.STRING,
number=1,
)
display_name = proto.Field(
proto.STRING,
number=2,
)
datasets = proto.RepeatedField(
proto.STRING,
number=3,
)
annotation_labels = proto.MapField(
proto.STRING,
proto.STRING,
number=12,
)
labeler_count = proto.Field(
proto.INT32,
number=4,
)
instruction_uri = proto.Field(
proto.STRING,
number=5,
)
inputs_schema_uri = proto.Field(
proto.STRING,
number=6,
)
inputs = proto.Field(
proto.MESSAGE,
number=7,
message=struct_pb2.Value,
)
state = proto.Field(
proto.ENUM,
number=8,
enum=job_state.JobState,
)
labeling_progress = proto.Field(
proto.INT32,
number=13,
)
current_spend = proto.Field(
proto.MESSAGE,
number=14,
message=money_pb2.Money,
)
create_time = proto.Field(
proto.MESSAGE,
number=9,
message=timestamp_pb2.Timestamp,
)
update_time = proto.Field(
proto.MESSAGE,
number=10,
message=timestamp_pb2.Timestamp,
)
error = proto.Field(
proto.MESSAGE,
number=22,
message=status_pb2.Status,
)
labels = proto.MapField(
proto.STRING,
proto.STRING,
number=11,
)
specialist_pools = proto.RepeatedField(
proto.STRING,
number=16,
)
encryption_spec = proto.Field(
proto.MESSAGE,
number=20,
message=gca_encryption_spec.EncryptionSpec,
)
active_learning_config = proto.Field(
proto.MESSAGE,
number=21,
message="ActiveLearningConfig",
)