googleapis
Version:
Google APIs Client Library for Node.js
1,278 lines • 2.05 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace searchads360_v23 {
export interface Options extends GlobalOptions {
version: 'v23';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Search Ads 360 Reporting API
*
* The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.
*
* @example
* ```js
* const {google} = require('googleapis');
* const searchads360 = google.searchads360('v23');
* ```
*/
export class Searchads360 {
context: APIRequestContext;
audienceInsights: Resource$Audienceinsights;
customers: Resource$Customers;
geoTargetConstants: Resource$Geotargetconstants;
incentives: Resource$Incentives;
keywordThemeConstants: Resource$Keywordthemeconstants;
searchAds360Fields: Resource$Searchads360fields;
v23: Resource$V23;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A generic data container.
*/
export interface Schema$GoogleAdsSearchads360V0Common__Value {
/**
* A boolean.
*/
booleanValue?: boolean | null;
/**
* A double.
*/
doubleValue?: number | null;
/**
* A float.
*/
floatValue?: number | null;
/**
* An int64.
*/
int64Value?: string | null;
/**
* A string.
*/
stringValue?: string | null;
}
/**
* A part of a field path.
*/
export interface Schema$GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement {
/**
* The name of a field or a oneof
*/
fieldName?: string | null;
/**
* If field_name is a repeated field, this is the element that failed
*/
index?: number | null;
}
/**
* The error reason represented by type and enum.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorCode {
/**
* Indicates failure to properly authenticate user.
*/
authenticationError?: string | null;
/**
* An error encountered when trying to authorize a user.
*/
authorizationError?: string | null;
/**
* The reasons for the conversion custom variable error
*/
conversionCustomVariableError?: string | null;
/**
* The reasons for the custom column error
*/
customColumnError?: string | null;
/**
* The reasons for the date error
*/
dateError?: string | null;
/**
* The reasons for the date range error
*/
dateRangeError?: string | null;
/**
* The reasons for the distinct error
*/
distinctError?: string | null;
/**
* The reasons for the header error.
*/
headerError?: string | null;
/**
* An unexpected server-side error.
*/
internalError?: string | null;
/**
* The reasons for invalid parameter errors.
*/
invalidParameterError?: string | null;
/**
* An error with the query
*/
queryError?: string | null;
/**
* An error with the amount of quota remaining.
*/
quotaError?: string | null;
/**
* An error caused by the request
*/
requestError?: string | null;
/**
* The reasons for the size limit error
*/
sizeLimitError?: string | null;
}
/**
* Additional error details.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorDetails {
/**
* Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.
*/
quotaErrorDetails?: Schema$GoogleAdsSearchads360V0Errors__QuotaErrorDetails;
/**
* The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.
*/
unpublishedErrorCode?: string | null;
}
/**
* Describes the part of the request proto that caused the error.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorLocation {
/**
* A field path that indicates which field was invalid in the request.
*/
fieldPathElements?: Schema$GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement[];
}
/**
* Additional quota error details when there is QuotaError.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__QuotaErrorDetails {
/**
* The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".
*/
rateName?: string | null;
/**
* The rate scope of the quota limit.
*/
rateScope?: string | null;
/**
* Backoff period that customers should wait before sending next request.
*/
retryDelay?: string | null;
}
/**
* Search Ads 360-specific error.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__SearchAds360Error {
/**
* Additional error details, which are returned by certain error codes. Most error codes do not include details.
*/
details?: Schema$GoogleAdsSearchads360V0Errors__ErrorDetails;
/**
* An enum value that indicates which error occurred.
*/
errorCode?: Schema$GoogleAdsSearchads360V0Errors__ErrorCode;
/**
* Describes the part of the request proto that caused the error.
*/
location?: Schema$GoogleAdsSearchads360V0Errors__ErrorLocation;
/**
* A human-readable description of the error.
*/
message?: string | null;
/**
* The value that triggered the error.
*/
trigger?: Schema$GoogleAdsSearchads360V0Common__Value;
}
/**
* Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__SearchAds360Failure {
/**
* The list of errors that occurred.
*/
errors?: Schema$GoogleAdsSearchads360V0Errors__SearchAds360Error[];
/**
* The unique ID of the request that is used for debugging purposes.
*/
requestId?: string | null;
}
/**
* Retention campaign goal settings.
*/
export interface Schema$GoogleAdsSearchads360V23Common_CampaignGoalSettings_CampaignRetentionGoalSettings {
/**
* Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
*/
targetOption?: string | null;
/**
* Retention goal campaign specific value settings.
*/
valueSettingsOverride?: Schema$GoogleAdsSearchads360V23Common__CustomerLifecycleOptimizationValueSettings;
}
/**
* Retention goal settings.
*/
export interface Schema$GoogleAdsSearchads360V23Common_GoalSetting_RetentionGoal {
/**
* Retention goal value settings.
*/
valueSettings?: Schema$GoogleAdsSearchads360V23Common__CustomerLifecycleOptimizationValueSettings;
}
/**
* A YouTube channel returned as an example of the content in a lineup.
*/
export interface Schema$GoogleAdsSearchads360V23Common_LineupAttributeMetadata_SampleChannel {
/**
* The name of the sample channel.
*/
displayName?: string | null;
/**
* A YouTube channel.
*/
youtubeChannel?: Schema$GoogleAdsSearchads360V23Common__YouTubeChannelInfo;
/**
* Metadata for the sample channel.
*/
youtubeChannelMetadata?: Schema$GoogleAdsSearchads360V23Common__YouTubeChannelAttributeMetadata;
}
/**
* Indicates that a resource's ability to serve in a particular country is constrained.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint {
/**
* Geo target constant resource name of the country in which serving is constrained.
*/
countryCriterion?: string | null;
}
/**
* A list of countries where a resource's serving is constrained.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraintList {
/**
* Countries in which serving is restricted.
*/
countries?: Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_CountryConstraint[];
/**
* Total number of countries targeted by the resource.
*/
totalTargetedCountries?: number | null;
}
/**
* Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicConstraint_ResellerConstraint {
}
/**
* Evidence of mismatches between the URLs of a resource.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationMismatch {
/**
* The set of URLs that did not match each other.
*/
urlTypes?: string[] | null;
}
/**
* Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationNotWorking {
/**
* The type of device that failed to load the URL.
*/
device?: string | null;
/**
* The type of DNS error.
*/
dnsErrorType?: string | null;
/**
* The full URL that didn't work.
*/
expandedUrl?: string | null;
/**
* The HTTP error code.
*/
httpErrorCode?: string | null;
/**
* The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
*/
lastCheckedDateTime?: string | null;
}
/**
* A list of strings found in a destination page that caused a policy finding.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_DestinationTextList {
/**
* List of text found in the resource's destination page.
*/
destinationTexts?: string[] | null;
}
/**
* A list of fragments of text that violated a policy.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_TextList {
/**
* The fragments of text from the resource that caused the policy finding.
*/
texts?: string[] | null;
}
/**
* A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.
*/
export interface Schema$GoogleAdsSearchads360V23Common_PolicyTopicEvidence_WebsiteList {
/**
* Websites that caused the policy finding.
*/
websites?: string[] | null;
}
/**
* The city where the travel activity is available.
*/
export interface Schema$GoogleAdsSearchads360V23Common__ActivityCityInfo {
/**
* String value of the activity city. The Geo Target Constant resource name.
*/
value?: string | null;
}
/**
* The country where the travel activity is available.
*/
export interface Schema$GoogleAdsSearchads360V23Common__ActivityCountryInfo {
/**
* String value of the activity country. The Geo Target Constant resource name.
*/
value?: string | null;
}
/**
* Advertiser-specific activity ID.
*/
export interface Schema$GoogleAdsSearchads360V23Common__ActivityIdInfo {
/**
* String value of the activity ID.
*/
value?: string | null;
}
/**
* Rating of the activity as a number 1 to 5, where 5 is the best.
*/
export interface Schema$GoogleAdsSearchads360V23Common__ActivityRatingInfo {
/**
* Long value of the activity rating.
*/
value?: string | null;
}
/**
* The state where the travel activity is available.
*/
export interface Schema$GoogleAdsSearchads360V23Common__ActivityStateInfo {
/**
* String value of the activity state. The Geo Target Constant resource name.
*/
value?: string | null;
}
/**
* An app deep link used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdAppDeepLinkAsset {
/**
* The Asset resource name of this app deep link asset.
*/
asset?: string | null;
}
/**
* Contains policy information for an asset inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdAssetPolicySummary {
/**
* The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.
*/
approvalStatus?: string | null;
/**
* The list of policy findings for this asset.
*/
policyTopicEntries?: Schema$GoogleAdsSearchads360V23Common__PolicyTopicEntry[];
/**
* Where in the review process this asset.
*/
reviewStatus?: string | null;
}
/**
* A call to action asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdCallToActionAsset {
/**
* The Asset resource name of this call to action asset.
*/
asset?: string | null;
}
/**
* A Demand Gen carousel card asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdDemandGenCarouselCardAsset {
/**
* The Asset resource name of this discovery carousel card.
*/
asset?: string | null;
}
/**
* Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdditionalApplicationInfo {
/**
* The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated.
*/
applicationId?: string | null;
/**
* The instance type of the application sending the request.
*/
applicationInstance?: string | null;
}
/**
* Address for proximity criterion.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AddressInfo {
/**
* Name of the city.
*/
cityName?: string | null;
/**
* Country code.
*/
countryCode?: string | null;
/**
* Postal code.
*/
postalCode?: string | null;
/**
* Province or state code.
*/
provinceCode?: string | null;
/**
* Province or state name.
*/
provinceName?: string | null;
/**
* Street address line 1.
*/
streetAddress?: string | null;
/**
* Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
*/
streetAddress2?: string | null;
}
/**
* An image asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdImageAsset {
/**
* The Asset resource name of this image.
*/
asset?: string | null;
}
/**
* A media bundle asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdMediaBundleAsset {
/**
* The Asset resource name of this media bundle.
*/
asset?: string | null;
}
/**
* Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdScheduleInfo {
/**
* Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
dayOfWeek?: string | null;
/**
* Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
endHour?: number | null;
/**
* Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
endMinute?: string | null;
/**
* Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
startHour?: number | null;
/**
* Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
startMinute?: string | null;
}
/**
* A text asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdTextAsset {
/**
* The performance label of this text asset.
*/
assetPerformanceLabel?: string | null;
/**
* The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
*/
pinnedField?: string | null;
/**
* The policy summary of this text asset.
*/
policySummaryInfo?: Schema$GoogleAdsSearchads360V23Common__AdAssetPolicySummary;
/**
* Asset text.
*/
text?: string | null;
}
/**
* A video asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdVideoAsset {
/**
* Contains info fields for this AdVideoAsset.
*/
adVideoAssetInfo?: Schema$GoogleAdsSearchads360V23Common__AdVideoAssetInfo;
/**
* The Asset resource name of this video.
*/
asset?: string | null;
}
/**
* Contains info fields for AdVideoAssets.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdVideoAssetInfo {
/**
* Defines feature controls for this AdVideoAsset during serving time. For example, whether YouTube comments should be enabled for Partnership Ads served on YouTube Shorts.
*/
adVideoAssetFeatureControl?: Schema$GoogleAdsSearchads360V23Common__AdVideoAssetLinkFeatureControl;
}
/**
* YouTube Video Asset feature controls.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AdVideoAssetLinkFeatureControl {
/**
* Defines if YouTube comments should be enabled for the creative using this YouTube video asset served on YouTube Shorts.
*/
allowYoutubeComments?: boolean | null;
}
/**
* Dimension specifying users by their age.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AgeDimension {
/**
* Contiguous age range to be included in the dimension.
*/
ageRanges?: Schema$GoogleAdsSearchads360V23Common__AgeSegment[];
/**
* Include users whose age is not determined.
*/
includeUndetermined?: boolean | null;
}
/**
* An age range criterion.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AgeRangeInfo {
/**
* Type of the age range.
*/
type?: string | null;
}
/**
* Contiguous age range.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AgeSegment {
/**
* Maximum age to include. A maximum age need not be specified. If specified, max_age must be greater than min_age, and allowed values are 24, 34, 44, 54, and 64.
*/
maxAge?: number | null;
/**
* Minimum age to include. A minimum age must be specified and must be at least 18. Allowed values are 18, 25, 35, 45, 55, and 65.
*/
minAge?: number | null;
}
/**
* An app ad.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AppAdInfo {
/**
* An app deep link asset that may be used with the ad.
*/
appDeepLink?: Schema$GoogleAdsSearchads360V23Common__AdAppDeepLinkAsset;
/**
* List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
*/
descriptions?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of text assets for headlines. When the ad serves the headlines will be selected from this list.
*/
headlines?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of media bundle assets that may be used with the ad.
*/
html5MediaBundles?: Schema$GoogleAdsSearchads360V23Common__AdMediaBundleAsset[];
/**
* List of image assets that may be displayed with the ad.
*/
images?: Schema$GoogleAdsSearchads360V23Common__AdImageAsset[];
/**
* Mandatory ad text.
*/
mandatoryAdText?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset;
/**
* List of YouTube video assets that may be displayed with the ad.
*/
youtubeVideos?: Schema$GoogleAdsSearchads360V23Common__AdVideoAsset[];
}
/**
* An app deep link asset
*/
export interface Schema$GoogleAdsSearchads360V23Common__AppDeepLinkAsset {
/**
* The uri for the app deep link, The uri can be either a custom scheme uri (e.g. mystore://shoes) or universal uri (e.g. http://www.mystore.com/shoes).
*/
appDeepLinkUri?: string | null;
}
/**
* App engagement ads allow you to write text encouraging a specific action in the app, like checking in, making a purchase, or booking a flight. They allow you to send users to a specific part of your app where they can find what they're looking for easier and faster.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AppEngagementAdInfo {
/**
* List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
*/
descriptions?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of text assets for headlines. When the ad serves the headlines will be selected from this list.
*/
headlines?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of image assets that may be displayed with the ad.
*/
images?: Schema$GoogleAdsSearchads360V23Common__AdImageAsset[];
/**
* List of video assets that may be displayed with the ad.
*/
videos?: Schema$GoogleAdsSearchads360V23Common__AdVideoAsset[];
}
/**
* An app payment model criterion.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AppPaymentModelInfo {
/**
* Type of the app payment model.
*/
type?: string | null;
}
/**
* App pre-registration ads link to your app or game listing on Google Play, and can run on Google Play, on YouTube (in-stream only), and within other apps and mobile websites on the Display Network. It will help capture people's interest in your app or game and generate an early install base for your app or game before a launch.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AppPreRegistrationAdInfo {
/**
* List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
*/
descriptions?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of text assets for headlines. When the ad serves the headlines will be selected from this list.
*/
headlines?: Schema$GoogleAdsSearchads360V23Common__AdTextAsset[];
/**
* List of image asset IDs whose images may be displayed with the ad.
*/
images?: Schema$GoogleAdsSearchads360V23Common__AdImageAsset[];
/**
* List of YouTube video asset IDs whose videos may be displayed with the ad.
*/
youtubeVideos?: Schema$GoogleAdsSearchads360V23Common__AdVideoAsset[];
}
/**
* Details related to AssetLinkPrimaryStatusReasonPB.ASSET_DISAPPROVED
*/
export interface Schema$GoogleAdsSearchads360V23Common__AssetDisapproved {
/**
* Provides the quality evaluation disapproval reason of an asset.
*/
offlineEvaluationErrorReasons?: string[] | null;
}
/**
* An AssetInteractionTarget segment.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AssetInteractionTarget {
/**
* The asset resource name.
*/
asset?: string | null;
/**
* Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
*/
interactionOnThisAsset?: boolean | null;
}
/**
* Provides the detail of a PrimaryStatus. Each asset link has a PrimaryStatus value (e.g. NOT_ELIGIBLE, meaning not serving), and list of corroborating PrimaryStatusReasons (e.g. [ASSET_DISAPPROVED]). Each reason may have some additional details annotated with it. For instance, when the reason is ASSET_DISAPPROVED, the details field will contain additional information about the offline evaluation errors which led to the asset being disapproved.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AssetLinkPrimaryStatusDetails {
/**
* Provides the details for AssetLinkPrimaryStatusReason.ASSET_DISAPPROVED
*/
assetDisapproved?: Schema$GoogleAdsSearchads360V23Common__AssetDisapproved;
/**
* Provides the reason of this PrimaryStatus.
*/
reason?: string | null;
/**
* Provides the PrimaryStatus of this status detail.
*/
status?: string | null;
}
/**
* Contains the usage information of the asset.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AssetUsage {
/**
* Resource name of the asset.
*/
asset?: string | null;
/**
* The served field type of the asset.
*/
servedAssetFieldType?: string | null;
}
/**
* Positive dimension specifying user's audience.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceDimension {
/**
* Dimension specifying users by their age.
*/
age?: Schema$GoogleAdsSearchads360V23Common__AgeDimension;
/**
* Dimension specifying users by their membership in other audience segments.
*/
audienceSegments?: Schema$GoogleAdsSearchads360V23Common__AudienceSegmentDimension;
/**
* Dimension specifying users by their gender.
*/
gender?: Schema$GoogleAdsSearchads360V23Common__GenderDimension;
/**
* Dimension specifying users by their household income.
*/
householdIncome?: Schema$GoogleAdsSearchads360V23Common__HouseholdIncomeDimension;
/**
* Dimension specifying users by their parental status.
*/
parentalStatus?: Schema$GoogleAdsSearchads360V23Common__ParentalStatusDimension;
}
/**
* Negative dimension specifying users to exclude from the audience.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceExclusionDimension {
/**
* Audience segment to be excluded.
*/
exclusions?: Schema$GoogleAdsSearchads360V23Common__ExclusionSegment[];
}
/**
* An audience criterion.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInfo {
/**
* The Audience resource name.
*/
audience?: string | null;
}
/**
* An audience attribute that can be used to request insights about the audience.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsAttribute {
/**
* An audience attribute defined by an age range.
*/
ageRange?: Schema$GoogleAdsSearchads360V23Common__AgeRangeInfo;
/**
* An audience attribute defined by interest in a Product & Service category.
*/
category?: Schema$GoogleAdsSearchads360V23Common__AudienceInsightsCategory;
/**
* A device type. (Mobile, Desktop, Tablet)
*/
device?: Schema$GoogleAdsSearchads360V23Common__DeviceInfo;
/**
* An audience attribute defined by interest in a topic represented by a Knowledge Graph entity.
*/
entity?: Schema$GoogleAdsSearchads360V23Common__AudienceInsightsEntity;
/**
* An audience attribute defined by a gender.
*/
gender?: Schema$GoogleAdsSearchads360V23Common__GenderInfo;
/**
* A household income percentile range.
*/
incomeRange?: Schema$GoogleAdsSearchads360V23Common__IncomeRangeInfo;
/**
* A YouTube Lineup.
*/
lineup?: Schema$GoogleAdsSearchads360V23Common__AudienceInsightsLineup;
/**
* An audience attribute defined by a geographic location.
*/
location?: Schema$GoogleAdsSearchads360V23Common__LocationInfo;
/**
* A Parental Status value (parent, or not a parent).
*/
parentalStatus?: Schema$GoogleAdsSearchads360V23Common__ParentalStatusInfo;
/**
* An Affinity or In-Market audience.
*/
userInterest?: Schema$GoogleAdsSearchads360V23Common__UserInterestInfo;
/**
* A User List.
*/
userList?: Schema$GoogleAdsSearchads360V23Common__UserListInfo;
/**
* A YouTube channel.
*/
youtubeChannel?: Schema$GoogleAdsSearchads360V23Common__YouTubeChannelInfo;
/**
* A YouTube video.
*/
youtubeVideo?: Schema$GoogleAdsSearchads360V23Common__YouTubeVideoInfo;
}
/**
* An audience attribute, with metadata about it, returned in response to a search.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata {
/**
* The attribute itself.
*/
attribute?: Schema$GoogleAdsSearchads360V23Common__AudienceInsightsAttribute;
/**
* The type of the attribute.
*/
dimension?: string | null;
/**
* A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear".
*/
displayInfo?: string | null;
/**
* The human-readable name of the attribute.
*/
displayName?: string | null;
/**
* Special metadata for a Knowledge Graph Entity.
*/
knowledgeGraphAttributeMetadata?: Schema$GoogleAdsSearchads360V23Common__KnowledgeGraphAttributeMetadata;
/**
* Special metadata for a YouTube Lineup.
*/
lineupAttributeMetadata?: Schema$GoogleAdsSearchads360V23Common__LineupAttributeMetadata;
/**
* Special metadata for a Location.
*/
locationAttributeMetadata?: Schema$GoogleAdsSearchads360V23Common__LocationAttributeMetadata;
/**
* An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response.
*/
potentialYoutubeReach?: string | null;
/**
* The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response.
*/
subscriberShare?: number | null;
/**
* Special metadata for a User Interest.
*/
userInterestAttributeMetadata?: Schema$GoogleAdsSearchads360V23Common__UserInterestAttributeMetadata;
/**
* Special metadata for a User List.
*/
userListAttributeMetadata?: Schema$GoogleAdsSearchads360V23Common__UserListAttributeMetadata;
/**
* The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response.
*/
viewerShare?: number | null;
/**
* Special metadata for a YouTube channel.
*/
youtubeChannelMetadata?: Schema$GoogleAdsSearchads360V23Common__YouTubeChannelAttributeMetadata;
/**
* Special metadata for a YouTube video.
*/
youtubeVideoMetadata?: Schema$GoogleAdsSearchads360V23Common__YouTubeVideoAttributeMetadata;
}
/**
* A group of audience attributes with metadata, returned in response to a search.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadataGroup {
/**
* Attributes with metadata returned in response to a search.
*/
attributes?: Schema$GoogleAdsSearchads360V23Common__AudienceInsightsAttributeMetadata[];
}
/**
* A Product and Service category.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsCategory {
/**
* Required. The criterion ID of the category.
*/
categoryId?: string | null;
}
/**
* A Knowledge Graph entity, represented by its machine id.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsEntity {
/**
* Required. The machine ID (mid) of the Knowledge Graph entity.
*/
knowledgeGraphMachineId?: string | null;
}
/**
* A YouTube Lineup.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceInsightsLineup {
/**
* Required. The numeric ID of the lineup.
*/
lineupId?: string | null;
}
/**
* Positive audience segment.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceSegment {
/**
* Custom audience segment.
*/
customAudience?: Schema$GoogleAdsSearchads360V23Common__CustomAudienceSegment;
/**
* Detailed demographic segment.
*/
detailedDemographic?: Schema$GoogleAdsSearchads360V23Common__DetailedDemographicSegment;
/**
* Live-event audience segment.
*/
lifeEvent?: Schema$GoogleAdsSearchads360V23Common__LifeEventSegment;
/**
* Affinity or In-market segment.
*/
userInterest?: Schema$GoogleAdsSearchads360V23Common__UserInterestSegment;
/**
* User list segment.
*/
userList?: Schema$GoogleAdsSearchads360V23Common__UserListSegment;
}
/**
* Dimension specifying users by their membership in other audience segments.
*/
export interface Schema$GoogleAdsSearchads360V23Common__AudienceSegmentDimension {
/**
* Included audience segments. Users are included if they belong to at least one segment.
*/
segments?: Schema$GoogleAdsSearchads360V23Common__AudienceSegment[];
}
export interface Schema$GoogleAdsSearchads360V23Common__BasicUserListInfo {
/**
* Actions associated with this user list.
*/
actions?: Schema$GoogleAdsSearchads360V23Common__UserListActionInfo[];
}
/**
* A Book on Google asset. Used to redirect user to book through Google. Book on Google will change the redirect url to book directly through Google.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BookOnGoogleAsset {
}
/**
* Represents a Brand Criterion used for targeting based on commercial knowledge graph.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BrandInfo {
/**
* Output only. A text representation of a brand.
*/
displayName?: string | null;
/**
* The Commercial KG MID for the brand.
*/
entityId?: string | null;
/**
* Output only. The primary url of a brand.
*/
primaryUrl?: string | null;
/**
* Output only. The rejection reason when a brand status is REJECTED.
*/
rejectionReason?: string | null;
/**
* Output only. The status of a brand.
*/
status?: string | null;
}
/**
* A Brand List Criterion is used to specify a list of brands. The list is represented as a SharedSet id type BRAND_HINT. A criterion of this type can be either targeted or excluded.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BrandListInfo {
/**
* Shared set resource name of the brand list.
*/
sharedSet?: string | null;
}
/**
* Projected metrics for a specific budget amount.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BudgetSimulationPoint {
/**
* Projected number of biddable conversions.
*/
biddableConversions?: number | null;
/**
* Projected total value of biddable conversions.
*/
biddableConversionsValue?: number | null;
/**
* The simulated budget upon which projected metrics are based.
*/
budgetAmountMicros?: string | null;
/**
* Projected number of clicks.
*/
clicks?: string | null;
/**
* Projected cost in micros.
*/
costMicros?: string | null;
/**
* Projected number of impressions.
*/
impressions?: string | null;
/**
* Projected number of interactions. Only discovery advertising channel type supports this field.
*/
interactions?: string | null;
/**
* Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency. Only campaigns with the Target Spend bidding strategy support this field.
*/
requiredCpcBidCeilingMicros?: string | null;
/**
* Projected number of top slot impressions. Only search advertising channel type supports this field.
*/
topSlotImpressions?: string | null;
}
/**
* A container for simulation points for simulations of type BUDGET.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BudgetSimulationPointList {
/**
* Projected metrics for a series of budget amounts.
*/
points?: Schema$GoogleAdsSearchads360V23Common__BudgetSimulationPoint[];
}
/**
* A business message asset.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessMessageAsset {
/**
* A call to action for the business message asset.
*/
callToAction?: Schema$GoogleAdsSearchads360V23Common__BusinessMessageCallToActionInfo;
/**
* Facebook Messenger.
*/
facebookMessengerInfo?: Schema$GoogleAdsSearchads360V23Common__FacebookMessengerBusinessMessageInfo;
/**
* Required. Message provider of the business message asset.
*/
messageProvider?: string | null;
/**
* Required. A welcome message to prompt the user to initiate a conversation.
*/
starterMessage?: string | null;
/**
* Whatsapp.
*/
whatsappInfo?: Schema$GoogleAdsSearchads360V23Common__WhatsappBusinessMessageInfo;
/**
* Zalo.
*/
zaloInfo?: Schema$GoogleAdsSearchads360V23Common__ZaloBusinessMessageInfo;
}
/**
* Display information that encourages the user to take action.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessMessageCallToActionInfo {
/**
* Required. Text providing a clear value proposition of what users expect once they take the action. Examples: 'Message us for a quote', 'Ask our expert team'.
*/
callToActionDescription?: string | null;
/**
* Required. Pre-defined call to action text.
*/
callToActionSelection?: string | null;
}
/**
* Business Profile location group business name filter.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessProfileBusinessNameFilter {
/**
* Business name string to use for filtering.
*/
businessName?: string | null;
/**
* The type of string matching to use when filtering with business_name.
*/
filterType?: string | null;
}
/**
* Business Profile location data synced from the linked Business Profile account.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessProfileLocation {
/**
* Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
*/
labels?: string[] | null;
/**
* Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
*/
listingId?: string | null;
/**
* Business Profile store code of this location. This is synced from the Business Profile account.
*/
storeCode?: string | null;
}
/**
* Information about a Business Profile dynamic location group. Only applicable if the sync level AssetSet's type is LOCATION_SYNC and sync source is Business Profile.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessProfileLocationGroup {
/**
* Filter for dynamic Business Profile location sets.
*/
dynamicBusinessProfileLocationGroupFilter?: Schema$GoogleAdsSearchads360V23Common__DynamicBusinessProfileLocationGroupFilter;
}
/**
* Data used to configure a location set populated from Google Business Profile locations. Different types of filters are AND'ed together, if they are specified.
*/
export interface Schema$GoogleAdsSearchads360V23Common__BusinessProfileLocationSet {
/**
* Immutable. The account ID of the managed business whose locations are to be used. If this field is not set, then all businesses accessible by the user (specified by the emailAddress) are used.
*/
businessAccountId?: string | null;
/**
* Used to filter Google Business Profile listings by business name. If businessNameFilter is set, only listings with a matching business name are candidates to be sync'd into Assets.
*/
businessNameFilter?: string | null;
/**
* Required. Immutable. Email address of a Google Business Profile account or email address of a manager of the Google Business Profile account.
*/
emailAddress?: string | null;
/**
* Required. Immutable. The HTTP authorization token used to obtain authorization.
*/
httpAuthorizationToken?: string | null;
/**
* Used to filter Google Business Profile listings by labels. If entries exist in labelFilters, only listings that have any of the labels set are candidates to be synchronized into Assets. If no entries exist in labelFilters, then all listings are candidates for syncing. Label filters are OR'ed together.
*/
labelFilters?: string[] | null;
/**
* Used to filter Google Business Profile listings by listing id. If entries exist in listingIdFilters, only listings specified by the filters are candidates to be synchronized into Assets. If no entries exist in listingIdFilters, then all listings are candidates for syncing. Listing ID filters are OR'ed together.
*/
listingIdFilters?: string[] | null;
}
/**
* A Call asset.
*/
export interface Schema$GoogleAdsSearchads360V23Common__CallAsset {
/**
* List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
*/
adScheduleTargets?: Schema$GoogleAdsSearchads360V23Common__AdScheduleInfo[];
/**
* The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
*/
callConversionAction?: string | null;
/**
* Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
*/
callConversionReportingState?: string | null;
/**
* Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
*/
countryCode?: string | null;
/**
* Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
*/
phoneNumber?: string | null;
}
/**
* Represents a Call extension.
*/
export interface Schema$GoogleAdsSearchads360V23Common__CallFeedItem {
/**
* The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracking_enabled is set to true. Otherwise this field is ignored.
*/
callConversionAction?: string | null;
/**
* Enum value that indicates whether this call extension uses its own call conversion setting (or just have call conversion disabled), or following the account level setting.
*/
callConversionReportingState?: string | null;
/**
* If true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional.
*/
callConversionTrackingDisabled?: boolean | null;
/**
* Indicates whether call tracking is enabled. By default, call tracking is not enabled.
*/
callTrackingEnabled?: boolean | null;
/**
* Uppercase two-letter country code of the advertiser's phone number. This string must not be empty.
*/
countryCode?: string | null;
/**
* The advertiser's phone number to append to the ad. This s