媒体別リファレンス

各媒体はプロジェクト単位で接続されます。MCPツールは、接続済みかつ許可された媒体データだけを読み取ります。標準ツールが返す項目は returned_*、公式API/スキーマ上の項目は official_* / api_schema_field、追加候補は api_candidate、標準では返さない個人情報は pii_not_returned で分けています。Meta広告のactions/action_valuesは実データのaction_typeを actions_* / action_values_* として動的に列展開します。

GA4

分析・SEO / Google OAuth

提供中

セッション、ユーザー、キーイベント、CV、売上、ページ、流入チャネル、デバイス、地域、エンゲージメントを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_ga4_properties	なし	property_id / display_name / account	接続済みGA4プロパティを一覧化する
run_ga4_report	start_date, end_date, metrics, dimensions, property_id	row_count / rows	GA4の任意レポートを実行する
run_ga4_realtime_report	metrics, dimensions, property_id	row_count / rows	直近30分のリアルタイム指標を取得する
list_ga4_dimensions_metrics	property_id	dimensions / metrics	利用可能なdimension/metricを一覧化する

フィールド

ID	型	表示名	媒体側API名	説明
achievementId	official_dimension	Achievement ID	achievementId	The achievement ID in a game for an event. Populated by the event parameter achievement_id .
adFormat	official_dimension	Ad format	adFormat	Describes the way ads looked and where they were located. Typical formats include Interstitial , Banner , Rewarded , and Native advanced .
adSourceName	official_dimension	Ad source	adSourceName	The source network that served the ad. Typical sources include AdMob Network , Liftoff , Facebook Audience Network , and Mediated house ads .
adUnitName	official_dimension	Ad unit	adUnitName	The name you chose to describe this Ad unit. Ad units are containers you place in your apps to show ads to users.
appVersion	official_dimension	App version	appVersion	The app's versionName (Android) or short bundle version (iOS).
audienceId	official_dimension	Audience ID	audienceId	The numeric identifier of an Audience. Users are reported in the audiences to which they belonged during the report's date range. Current user behavior does not affect historical audience membership in reports.
audienceName	official_dimension	Audience name	audienceName	The given name of an Audience. Users are reported in the audiences to which they belonged during the report's date range. Current user behavior does not affect historical audience membership in reports.
audienceResourceName	official_dimension	Audience resource name	audienceResourceName	The resource name of this audience. Resource names contain both collection & resource identifiers to uniquely identify a resource; to learn more, see Resource names .
brandingInterest	official_dimension	Interests	brandingInterest	Interests demonstrated by users who are higher in the shopping funnel. Users can be counted in multiple interest categories. For example, Shoppers , Lifestyles & Hobbies/Pet Lovers , or Travel/Travel Buffs/Beachbound Travelers .
browser	official_dimension	Browser	browser	The browsers used to view your website.
browserVersion	official_dimension	Browser version	browserVersion	The version of the browser from which the user activity originated. For example, a version might appear as 146.0.7680.178 . To understand which browser this version belongs to, use this version alongside the Browser dimension.
campaignId	official_dimension	Campaign ID	campaignId	The identifier of the marketing campaign. Present only for key events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
campaignName	official_dimension	Campaign	campaignName	The name of the marketing campaign. Present only for key events. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
character	official_dimension	Character	character	The player character in a game for an event. Populated by the event parameter character .
city	official_dimension	City	city	The city from which the user activity originated.
cityId	official_dimension	City ID	cityId	The geographic ID of the city from which the user activity originated, derived from their IP address.
cm360AccountId	official_dimension	CM360 account ID	cm360AccountId	The CM360 Account ID that led to the key event. Identifies the CM360 Account.
cm360AccountName	official_dimension	CM360 account name	cm360AccountName	The CM360 Account Name that led to the key event. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
cm360AdvertiserId	official_dimension	CM360 advertiser ID	cm360AdvertiserId	The CM360 Advertiser ID that led to the key event. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
cm360AdvertiserName	official_dimension	CM360 advertiser name	cm360AdvertiserName	The CM360 Advertiser Name that led to the key event. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
cm360CampaignId	official_dimension	CM360 campaign ID	cm360CampaignId	The CM360 Campaign ID that led to the key event. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
cm360CampaignName	official_dimension	CM360 campaign name	cm360CampaignName	The CM360 Campaign Name that led to the key event. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
cm360CreativeFormat	official_dimension	CM360 creative format	cm360CreativeFormat	The CM360 Creative Format that led to the key event. CM360 creative formats are also referred to as creative types.
cm360CreativeId	official_dimension	CM360 creative ID	cm360CreativeId	The CM360 Creative ID that led to the key event. Identifies a CM360 creative.
cm360CreativeName	official_dimension	CM360 creative name	cm360CreativeName	The CM360 Creative Name that led to the key event. The name given to a CM360 creative.
cm360CreativeType	official_dimension	CM360 creative type	cm360CreativeType	The CM360 Creative Type that led to the key event. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
cm360CreativeTypeId	official_dimension	CM360 creative type ID	cm360CreativeTypeId	The CM360 Creative Type ID that led to the key event. Identifies a CM360 creative type.
cm360CreativeVersion	official_dimension	CM360 creative version	cm360CreativeVersion	The CM360 Creative Version that led to the key event. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
cm360Medium	official_dimension	CM360 medium	cm360Medium	The CM360 Medium that led to the key event. The CM360 medium is also referred to as the placement cost structure.
cm360PlacementCostStructure	official_dimension	CM360 placement cost structure	cm360PlacementCostStructure	The CM360 Placement Cost Structure that led to the key event. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
cm360PlacementId	official_dimension	CM360 placement ID	cm360PlacementId	The CM360 Placement ID that led to the key event. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
cm360PlacementName	official_dimension	CM360 placement name	cm360PlacementName	The CM360 Placement Name that led to the key event. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
cm360RenderingId	official_dimension	CM360 rendering ID	cm360RenderingId	The CM360 Rendering ID that led to the key event. Identifies a CM360 creative.
cm360SiteId	official_dimension	CM360 site ID	cm360SiteId	The CM360 Site ID that led to the key event. Identifies a CM360 site.
cm360SiteName	official_dimension	CM360 site name	cm360SiteName	The CM360 Site Name that led to the key event. The CM360 Site name from which the ad space was purchased.
cm360Source	official_dimension	CM360 source	cm360Source	The CM360 Source that led to the key event. The CM360 source is also referred to as the site name.
cm360SourceMedium	official_dimension	CM360 source / medium	cm360SourceMedium	The CM360 Source Medium that led to the key event. A combination of the source and medium.
cohort	official_dimension	Cohort	cohort	The cohort's name in the request. A cohort is a set of users who started using your website or app in any consecutive group of days. If a cohort name is not specified in the request, cohorts are named by their zero based index such as cohort_0 and cohort_1.
cohortNthDay	official_dimension	Daily cohort	cohortNthDay	Day offset relative to the firstSessionDate for the users in the cohort. For example, if a cohort is selected with the start and end date of 2020-03-01, then for the date 2020-03-02, cohortNthDay will be 0001.
cohortNthMonth	official_dimension	Monthly cohort	cohortNthMonth	Month offset relative to the firstSessionDate for the users in the cohort. Month boundaries align with calendar month boundaries. For example, if a cohort is selected with the start and end date in March 2020, then for any date in April 2020, cohortNthMonth w…
cohortNthWeek	official_dimension	Weekly cohort	cohortNthWeek	Week offset relative to the firstSessionDate for the users in the cohort. Weeks start on Sunday and end on Saturday. For example, if a cohort is selected with the start and end date in the range 2020-11-08 to 2020-11-14, then for the dates in the range 2020-1…
contentGroup	official_dimension	Content group	contentGroup	A category that applies to items of published content. Populated by the event parameter content_group .
contentId	official_dimension	Content ID	contentId	The identifier of the selected content. Populated by the event parameter content_id .
contentType	official_dimension	Content type	contentType	The category of the selected content. Populated by the event parameter content_type .
continent	official_dimension	Continent	continent	The continent from which the user activity originated. For example, Americas or Asia .
continentId	official_dimension	Continent ID	continentId	The geographic ID of the continent from which the user activity originated, derived from their IP address.
country	official_dimension	Country	country	The country from which the user activity originated.
countryId	official_dimension	Country ID	countryId	The geographic ID of the country from which the user activity originated, derived from their IP address. Formatted according to ISO 3166-1 alpha-2 standard.
currencyCode	official_dimension	Currency	currencyCode	The local currency code (based on ISO 4217 standard) of the eCommerce event. For example, USD or GBP . Currency is specified in tagging by the currency parameter. Businesses that transact in more than one currency can specify a local currency code when sendin…
date	official_dimension	Date	date	The date of the event, formatted as YYYYMMDD.
dateHour	official_dimension	Date + hour (YYYYMMDDHH)	dateHour	The combined values of date and hour formatted as YYYYMMDDHH.
dateHourMinute	official_dimension	Date hour and minute	dateHourMinute	The combined values of date, hour, and minute formatted as YYYYMMDDHHMM.
day	official_dimension	Day	day	The day of the month, a two-digit number from 01 to 31.
dayOfWeek	official_dimension	Day of week	dayOfWeek	The integer day of the week. It returns values in the range 0 to 6 with Sunday as the first day of the week.
dayOfWeekName	official_dimension	Day of week name	dayOfWeekName	The day of the week in English. This dimension has values such as Sunday or Monday.
defaultChannelGroup	official_dimension	Default channel group	defaultChannelGroup	The key event's default channel group is based primarily on source and medium. An enumeration which includes Direct , Organic Search , Paid Social , Organic Social , Email , Affiliates , Referral , Paid Search , Video , and Display .
deviceCategory	official_dimension	Device category	deviceCategory	The type of device: Desktop, Tablet, or Mobile.
deviceModel	official_dimension	Device model	deviceModel	The mobile device model (example: iPhone 10,6).
dv360AdvertiserId	official_dimension	DV360 advertiser ID	dv360AdvertiserId	The DV360 Advertiser ID that led to the key event. Identifies the DV360 advertiser.
dv360AdvertiserName	official_dimension	DV360 advertiser name	dv360AdvertiserName	The DV360 Advertiser Name that led to the key event. DV360 advertisers represent real-life businesses that run advertising campaigns.
dv360CampaignId	official_dimension	DV360 campaign ID	dv360CampaignId	The DV360 Campaign ID that led to the key event. Identifies the DV360 campaign.
dv360CampaignName	official_dimension	DV360 campaign name	dv360CampaignName	The DV360 Campaign Name that led to the key event. DV360 campaigns group together related insertion orders with a common business goal.
dv360CreativeFormat	official_dimension	DV360 creative format	dv360CreativeFormat	The DV360 Creative Format that led to the key event. Also referred to as the creative type. For example, expandable, video, or native.
dv360CreativeId	official_dimension	DV360 creative ID	dv360CreativeId	The DV360 Creative ID that led to the key event. Identifies the DV360 creative.
dv360CreativeName	official_dimension	DV360 creative name	dv360CreativeName	The DV360 Creative Name that led to the key event. The name given to a DV360 creative.
dv360ExchangeId	official_dimension	DV360 exchange ID	dv360ExchangeId	The DV360 Exchange ID that led to the key event. Identifies the DV360 exchange.
dv360ExchangeName	official_dimension	DV360 exchange name	dv360ExchangeName	The DV360 Exchange Name that led to the key event. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges .
dv360InsertionOrderId	official_dimension	DV360 insertion order ID	dv360InsertionOrderId	The DV360 Insertion Order ID that led to the key event. Identifies the DV360 insertion order.
dv360InsertionOrderName	official_dimension	DV360 insertion order name	dv360InsertionOrderName	The DV360 Insertion Order Name that led to the key event. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
dv360LineItemId	official_dimension	DV360 line item ID	dv360LineItemId	The DV360 Line Item ID that led to the key event. Identifies the DV360 line item.
dv360LineItemName	official_dimension	DV360 line item name	dv360LineItemName	The DV360 Line Item Name that led to the key event. A DV360 line item bids on impressions and serves creatives to inventory sources.
dv360Medium	official_dimension	DV360 medium	dv360Medium	The DV360 Medium that led to the key event. The billable outcome of the insertion order. For example, cpm .
dv360PartnerId	official_dimension	DV360 partner ID	dv360PartnerId	The DV360 Partner ID that led to the key event. Identifies the DV360 partner.
dv360PartnerName	official_dimension	DV360 partner name	dv360PartnerName	The DV360 Partner Name that led to the key event. DV360 partners represent agencies, trading desks, or large individual advertisers.
dv360Source	official_dimension	DV360 source	dv360Source	The DV360 Source that led to the key event. The DV360 site name where your ad was displayed.
dv360SourceMedium	official_dimension	DV360 source / medium	dv360SourceMedium	The DV360 Source Medium that led to the key event. A combination of the source and medium.
eventName	official_dimension	Event name	eventName	The name of the event.
fileExtension	official_dimension	File extension	fileExtension	The extension of the downloaded file (for example, pdf or txt ). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter file_extension .
fileName	official_dimension	File name	fileName	The page path of the downloaded file (for example, /menus/dinner-menu.pdf ). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter file_name .
firstSessionDate	official_dimension	First session date	firstSessionDate	The date the user's first session occurred, formatted as YYYYMMDD.
firstUserCampaignId	official_dimension	First user campaign ID	firstUserCampaignId	Identifier of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
firstUserCampaignName	official_dimension	First user campaign	firstUserCampaignName	Name of the marketing campaign that first acquired the user. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
firstUserCm360AccountId	official_dimension	First user CM360 account ID	firstUserCm360AccountId	The CM360 Account ID that originally acquired the user. Identifies the CM360 account.
firstUserCm360AccountName	official_dimension	First user CM360 account name	firstUserCm360AccountName	The CM360 Account Name that originally acquired the user. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
firstUserCm360AdvertiserId	official_dimension	First user CM360 advertiser ID	firstUserCm360AdvertiserId	The CM360 Advertiser ID that originally acquired the user. Identifies the CM360 advertiser.
firstUserCm360AdvertiserName	official_dimension	First user CM360 advertiser name	firstUserCm360AdvertiserName	The CM360 Advertiser Name that originally acquired the user. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
firstUserCm360CampaignId	official_dimension	First user CM360 campaign ID	firstUserCm360CampaignId	The CM360 Campaign ID that originally acquired the user. Identifies the CM360 campaign.
firstUserCm360CampaignName	official_dimension	First user CM360 campaign name	firstUserCm360CampaignName	The CM360 Campaign Name that originally acquired the user. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
firstUserCm360CreativeFormat	official_dimension	First user CM360 creative format	firstUserCm360CreativeFormat	The CM360 Creative Format that originally acquired the user. CM360 creative formats are also referred to as creative types.
firstUserCm360CreativeId	official_dimension	First user CM360 creative ID	firstUserCm360CreativeId	The CM360 Creative ID that originally acquired the user. Identifies a CM360 creative.
firstUserCm360CreativeName	official_dimension	First user CM360 creative name	firstUserCm360CreativeName	The CM360 Creative Name that originally acquired the user. The name given to a CM360 creative.
firstUserCm360CreativeType	official_dimension	First user CM360 creative type	firstUserCm360CreativeType	The CM360 Creative Type that originally acquired the user. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
firstUserCm360CreativeTypeId	official_dimension	First user CM360 creative type ID	firstUserCm360CreativeTypeId	The CM360 Creative Type ID that originally acquired the user. Identifies a CM360 creative type.
firstUserCm360CreativeVersion	official_dimension	First user CM360 creative version	firstUserCm360CreativeVersion	The CM360 Creative Version that originally acquired the user. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
firstUserCm360Medium	official_dimension	First user CM360 medium	firstUserCm360Medium	The CM360 Medium that originally acquired the user. The CM360 medium is also referred to as the placement cost structure.
firstUserCm360PlacementCostStructure	official_dimension	First user CM360 placement cost structure	firstUserCm360PlacementCostStructure	The CM360 Placement Cost Structure that originally acquired the user. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
firstUserCm360PlacementId	official_dimension	First user CM360 placement ID	firstUserCm360PlacementId	The CM360 Placement ID that originally acquired the user. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
firstUserCm360PlacementName	official_dimension	First user CM360 placement name	firstUserCm360PlacementName	The CM360 Placement Name that originally acquired the user. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
firstUserCm360RenderingId	official_dimension	First user CM360 rendering ID	firstUserCm360RenderingId	The CM360 Rendering ID that originally acquired the user. Identifies a CM360 creative.
firstUserCm360SiteId	official_dimension	First user CM360 site ID	firstUserCm360SiteId	The CM360 Site ID that originally acquired the user. Identifies a CM360 site.
firstUserCm360SiteName	official_dimension	First user CM360 site name	firstUserCm360SiteName	The CM360 Site Name that originally acquired the user. The CM360 Site name from which the ad space was purchased.
firstUserCm360Source	official_dimension	First user CM360 source	firstUserCm360Source	The CM360 Source that originally acquired the user. The CM360 source is also referred to as the site name.
firstUserCm360SourceMedium	official_dimension	First user CM360 source / medium	firstUserCm360SourceMedium	The CM360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserDefaultChannelGroup	official_dimension	First user default channel group	firstUserDefaultChannelGroup	The default channel group that first acquired the user. Default channel group is based primarily on source and medium. An enumeration which includes Direct , Organic Search , Paid Social , Organic Social , Email , Affiliates , Referral , Paid Search , Video ,…
firstUserDv360AdvertiserId	official_dimension	First user DV360 advertiser ID	firstUserDv360AdvertiserId	The DV360 Advertiser ID that originally acquired the user. Identifies the DV360 advertiser.
firstUserDv360AdvertiserName	official_dimension	First user DV360 advertiser name	firstUserDv360AdvertiserName	The DV360 Advertiser Name that originally acquired the user. DV360 advertisers represent real-life businesses that run advertising campaigns.
firstUserDv360CampaignId	official_dimension	First user DV360 campaign ID	firstUserDv360CampaignId	The DV360 Campaign ID that originally acquired the user. Identifies the DV360 campaign.
firstUserDv360CampaignName	official_dimension	First user DV360 campaign name	firstUserDv360CampaignName	The DV360 Campaign Name that originally acquired the user. DV360 campaigns group together related insertion orders with a common business goal.
firstUserDv360CreativeFormat	official_dimension	First user DV360 creative format	firstUserDv360CreativeFormat	The DV360 Creative Format that originally acquired the user. Also referred to as the creative type. For example, expandable, video, or native.
firstUserDv360CreativeId	official_dimension	First user DV360 creative ID	firstUserDv360CreativeId	The DV360 Creative ID that originally acquired the user. Identifies the DV360 creative.
firstUserDv360CreativeName	official_dimension	First user DV360 creative name	firstUserDv360CreativeName	The DV360 Creative Name that originally acquired the user. The name given to a DV360 creative.
firstUserDv360ExchangeId	official_dimension	First user DV360 exchange ID	firstUserDv360ExchangeId	The DV360 Exchange ID that originally acquired the user. Identifies the DV360 exchange.
firstUserDv360ExchangeName	official_dimension	First user DV360 exchange name	firstUserDv360ExchangeName	The DV360 Exchange Name that originally acquired the user. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges .
firstUserDv360InsertionOrderId	official_dimension	First user DV360 insertion order ID	firstUserDv360InsertionOrderId	The DV360 Insertion Order ID that originally acquired the user. Identifies the DV360 insertion order.
firstUserDv360InsertionOrderName	official_dimension	First user DV360 insertion order name	firstUserDv360InsertionOrderName	The DV360 Insertion Order Name that originally acquired the user. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
firstUserDv360LineItemId	official_dimension	First user DV360 line item ID	firstUserDv360LineItemId	The DV360 Line Item ID that originally acquired the user. Identifies the DV360 line item.
firstUserDv360LineItemName	official_dimension	First user DV360 line item name	firstUserDv360LineItemName	The DV360 Line Item Name that originally acquired the user. A DV360 line item bids on impressions and serves creatives to inventory sources.
firstUserDv360Medium	official_dimension	First user DV360 medium	firstUserDv360Medium	The DV360 Medium that originally acquired the user. The billable outcome of the insertion order. For example, cpm .
firstUserDv360PartnerId	official_dimension	First user DV360 partner ID	firstUserDv360PartnerId	The DV360 Partner ID that originally acquired the user. Identifies the DV360 partner.
firstUserDv360PartnerName	official_dimension	First user DV360 partner name	firstUserDv360PartnerName	The DV360 Partner Name that originally acquired the user. DV360 partners represent agencies, trading desks, or large individual advertisers.
firstUserDv360Source	official_dimension	First user DV360 source	firstUserDv360Source	The DV360 Source that originally acquired the user. The DV360 site name where your ad was displayed.
firstUserDv360SourceMedium	official_dimension	First user DV360 source / medium	firstUserDv360SourceMedium	The DV360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserGoogleAdsAccountName	official_dimension	First user Google Ads account name	firstUserGoogleAdsAccountName	The Account name from Google Ads that first acquired the user.
firstUserGoogleAdsAdGroupId	official_dimension	First user Google Ads ad group ID	firstUserGoogleAdsAdGroupId	The Ad Group Id in Google Ads that first acquired the user.
firstUserGoogleAdsAdGroupName	official_dimension	First user Google Ads ad group name	firstUserGoogleAdsAdGroupName	The Ad Group Name in Google Ads that first acquired the user.
firstUserGoogleAdsAdNetworkType	official_dimension	First user Google Ads ad network type	firstUserGoogleAdsAdNetworkType	The advertising network that first acquired the user. An enumeration which includes Google search , Search partners , Google Display Network , Youtube Search , Youtube Videos , Cross-network , Social , and (universal campaign) .
firstUserGoogleAdsCampaignId	official_dimension	First user Google Ads campaign ID	firstUserGoogleAdsCampaignId	Identifier of the Google Ads marketing campaign that first acquired the user.
firstUserGoogleAdsCampaignName	official_dimension	First user Google Ads campaign	firstUserGoogleAdsCampaignName	Name of the Google Ads marketing campaign that first acquired the user.
firstUserGoogleAdsCampaignType	official_dimension	First user Google Ads campaign type	firstUserGoogleAdsCampaignType	The campaign type of the Google Ads campaign that first acquired the user. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopp…
firstUserGoogleAdsCreativeId	official_dimension	First user Google Ads creative ID	firstUserGoogleAdsCreativeId	The ID of the Google Ads creative that first acquired the user. Creative IDs identify individual ads.
firstUserGoogleAdsCustomerId	official_dimension	First user Google Ads customer ID	firstUserGoogleAdsCustomerId	The Customer ID from Google Ads that first acquired the user. Customer IDs in Google Ads uniquely identify Google Ads accounts.
firstUserGoogleAdsKeyword	official_dimension	First user Google Ads keyword text	firstUserGoogleAdsKeyword	First user Google Ads keyword text
firstUserGoogleAdsQuery	official_dimension	First user Google Ads query	firstUserGoogleAdsQuery	The search query that first acquired the user.
firstUserManualAdContent	official_dimension	First user manual ad content	firstUserManualAdContent	The ad content that first acquired the user. Populated by the utm_content parameter.
firstUserManualCampaignId	official_dimension	First user manual campaign ID	firstUserManualCampaignId	The manual Campaign ID that originally acquired the user. Identifies the manual campaign. Populated by utm_id URL parameter.
firstUserManualCampaignName	official_dimension	First user manual campaign name	firstUserManualCampaignName	The manual Campaign Name that originally acquired the user. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs .
firstUserManualCreativeFormat	official_dimension	First user manual creative format	firstUserManualCreativeFormat	The manual Creative Format that originally acquired the user. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
firstUserManualMarketingTactic	official_dimension	First user manual marketing tactic	firstUserManualMarketingTactic	The manual Marketing Tactic that originally acquired the user. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
firstUserManualMedium	official_dimension	First user manual medium	firstUserManualMedium	The manual Medium that originally acquired the user. The marketing medium used in the referral. For example, cpc . Populated by utm_medium URL parameter.
firstUserManualSource	official_dimension	First user manual source	firstUserManualSource	The manual Source that originally acquired the user. The referrer. Populated by utm_source URL parameter.
firstUserManualSourceMedium	official_dimension	First user manual source / medium	firstUserManualSourceMedium	The manual Source Medium that originally acquired the user. A combination of the source and medium.
firstUserManualSourcePlatform	official_dimension	First user manual source platform	firstUserManualSourcePlatform	The manual Source Platform that originally acquired the user. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
firstUserManualTerm	official_dimension	First user manual term	firstUserManualTerm	The term that first acquired the user. Populated by the utm_term parameter.
firstUserMedium	official_dimension	First user medium	firstUserMedium	The medium that first acquired the user to your website or app.
firstUserPrimaryChannelGroup	official_dimension	First user primary channel group	firstUserPrimaryChannelGroup	The primary channel group that originally acquired a user. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn…
firstUserSa360AdGroupId	official_dimension	First user SA360 ad group ID	firstUserSa360AdGroupId	The SA360 Ad Group ID that originally acquired the user. Identifies the SA360 ad group.
firstUserSa360AdGroupName	official_dimension	First user SA360 ad group name	firstUserSa360AdGroupName	The SA360 Ad Group Name that originally acquired the user. SA360 Ad groups contain ads and keywords that relate to each other.
firstUserSa360CampaignId	official_dimension	First user SA360 campaign ID	firstUserSa360CampaignId	The SA360 Campaign ID that originally acquired the user. Identifies the SA360 campaign.
firstUserSa360CampaignName	official_dimension	First user SA360 campaign	firstUserSa360CampaignName	The SA360 Campaign Name that originally acquired the user. A SA360 campaign lets you organize your ads and define a goal for your advertising.
firstUserSa360CreativeFormat	official_dimension	First user SA360 creative format	firstUserSa360CreativeFormat	The SA360 Creative Format that originally acquired the user. The creative format is the specific layout or design of the advertisement used in a campaign.
firstUserSa360EngineAccountId	official_dimension	First user SA360 engine account ID	firstUserSa360EngineAccountId	The SA360 Engine Account ID that originally acquired the user. Identifies the SA360 engine account.
firstUserSa360EngineAccountName	official_dimension	First user SA360 engine account name	firstUserSa360EngineAccountName	The SA360 Engine Account Name that originally acquired the user. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account.
firstUserSa360EngineAccountType	official_dimension	First user SA360 engine account type	firstUserSa360EngineAccountType	The SA360 Engine Account Type that originally acquired the user. The type of engine used by the search engine account.
firstUserSa360KeywordText	official_dimension	First user SA360 keyword text	firstUserSa360KeywordText	The SA360 Keyword Text that originally acquired the user. The keywords that matched the search query.
firstUserSa360ManagerAccountId	official_dimension	First user SA360 manager account ID	firstUserSa360ManagerAccountId	The SA360 Manager Account ID that originally acquired the user. Identifies the SA360 manager account.
firstUserSa360ManagerAccountName	official_dimension	First user SA360 manager account name	firstUserSa360ManagerAccountName	The SA360 Manager Account Name that originally acquired the user. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
firstUserSa360Medium	official_dimension	First user SA360 medium	firstUserSa360Medium	The SA360 Medium that originally acquired the user. The payment mode used in ad buying. For example, cpc .
firstUserSa360Query	official_dimension	First user SA360 query	firstUserSa360Query	The SA360 Query that originally acquired the user. The search query typed by the user.
firstUserSa360Source	official_dimension	First user SA360 source	firstUserSa360Source	The SA360 Source that originally acquired the user. The search query happened on this site.
firstUserSa360SourceMedium	official_dimension	First user SA360 source / medium	firstUserSa360SourceMedium	The SA360 Source Medium that originally acquired the user. A combination of the source and medium.
firstUserSource	official_dimension	First user source	firstUserSource	The source that first acquired the user to your website or app.
firstUserSourceMedium	official_dimension	First user source / medium	firstUserSourceMedium	The combined values of the dimensions firstUserSource and firstUserMedium .
firstUserSourcePlatform	official_dimension	First user source platform	firstUserSourcePlatform	The source platform that first acquired the user. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
fullPageUrl	official_dimension	Full page URL	fullPageUrl	The hostname, page path, and query string for web pages visited; for example, the fullPageUrl portion of https://www.example.com/store/contact-us?query_string=true is www.example.com/store/contact-us?query_string=true .
googleAdsAccountName	official_dimension	Google Ads account name	googleAdsAccountName	The Account name from Google Ads for the campaign that led to the key event. Corresponds to customer.descriptive_name in the Google Ads API.
googleAdsAdGroupId	official_dimension	Google Ads ad group ID	googleAdsAdGroupId	The Google Ads ad group ID attributed to the key event.
googleAdsAdGroupName	official_dimension	Google Ads ad group name	googleAdsAdGroupName	The ad group name attributed to the key event.
googleAdsAdNetworkType	official_dimension	Google Ads ad network type	googleAdsAdNetworkType	The advertising network type of the key event. An enumeration which includes Google search , Search partners , Google Display Network , Youtube Search , Youtube Videos , Cross-network , Social , and (universal campaign) .
googleAdsCampaignId	official_dimension	Google Ads campaign ID	googleAdsCampaignId	The campaign ID for the Google Ads campaign attributed to the key event.
googleAdsCampaignName	official_dimension	Google Ads campaign	googleAdsCampaignName	The campaign name for the Google Ads campaign attributed to the key event.
googleAdsCampaignType	official_dimension	Google Ads campaign type	googleAdsCampaignType	The campaign type for the Google Ads campaign attributed to the key event. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopp…
googleAdsCreativeId	official_dimension	Google Ads creative ID	googleAdsCreativeId	The ID of the Google Ads creative attributed to the key event. Creative IDs identify individual ads.
googleAdsCustomerId	official_dimension	Google Ads customer ID	googleAdsCustomerId	The Customer ID from Google Ads for the campaign that led to key event. Customer IDs in Google Ads uniquely identify Google Ads accounts.
googleAdsKeyword	official_dimension	Google Ads keyword text	googleAdsKeyword	The matched keyword that led to the key event. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. To learn more about Keywords, see Keywords: Definition .
googleAdsQuery	official_dimension	Google Ads query	googleAdsQuery	The search query that led to the key event.
groupId	official_dimension	Group ID	groupId	The player group ID in a game for an event. Populated by the event parameter group_id .
hostName	official_dimension	Hostname	hostName	Includes the subdomain and domain names of a URL; for example, the Host Name of www.example.com/contact.html is www.example.com.
hour	official_dimension	Hour	hour	The two-digit hour of the day that the event was logged. This dimension ranges from 0-23 and is reported in your property's timezone.
isKeyEvent	official_dimension	Is key event	isKeyEvent	The string true if the event is a key event. Marking an event as a key event affects reports from time of creation. It doesn't change historic data. You can mark any event as key in Google Analytics, and some events (such as first_open or purchase ) are marke…
isoWeek	official_dimension	ISO week of the year	isoWeek	ISO week number, where each week starts on Monday. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 01, 02, & 53.
isoYear	official_dimension	ISO year	isoYear	The ISO year of the event. For details, see http://en.wikipedia.org/wiki/ISO_week_date. Example values include 2022 & 2023.
isoYearIsoWeek	official_dimension	ISO week of ISO year	isoYearIsoWeek	The combined values of isoWeek and isoYear. Example values include 201652 & 201701.
itemAffiliation	official_dimension	Item affiliation	itemAffiliation	The name or code of the affiliate (partner/vendor; if any) associated with an individual item. Populated by the affiliation item parameter.
itemBrand	official_dimension	Item brand	itemBrand	Brand name of the item.
itemCategory	official_dimension	Item category	itemCategory	The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Apparel is the item category.
itemCategory2	official_dimension	Item category 2	itemCategory2	The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Mens is the item category 2.
itemCategory3	official_dimension	Item category 3	itemCategory3	The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Summer is the item category 3.
itemCategory4	official_dimension	Item category 4	itemCategory4	The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, Shirts is the item category 4.
itemCategory5	official_dimension	Item category 5	itemCategory5	The hierarchical category in which the item is classified. For example, in Apparel/Mens/Summer/Shirts/T-shirts, T-shirts is the item category 5.
itemId	official_dimension	Item ID	itemId	The ID of the item.
itemListId	official_dimension	Item list ID	itemListId	The ID of the item list.
itemListName	official_dimension	Item list name	itemListName	The name of the item list.
itemListPosition	official_dimension	Item list position	itemListPosition	The position of an item in a list. For example, a product you sell in a list. This dimension is populated in tagging by the index parameter in the items array.
itemLocationID	official_dimension	Item location ID	itemLocationID	The physical location associated with the item. For example, the physical store location. It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. This field is populated in tagging by the loc…
itemName	official_dimension	Item name	itemName	The name of the item.
itemPromotionCreativeName	official_dimension	Item promotion creative name	itemPromotionCreativeName	The name of the item-promotion creative.
itemPromotionCreativeSlot	official_dimension	Item promotion creative slot	itemPromotionCreativeSlot	The name of the promotional creative slot associated with the item. This dimension can be specified in tagging by the creative_slot parameter at the event or item level. If the parameter is specified at both the event & item level, the item-level parameter is…
itemPromotionId	official_dimension	Item promotion ID	itemPromotionId	The ID of the item promotion.
itemPromotionName	official_dimension	Item promotion name	itemPromotionName	The name of the promotion for the item.
itemVariant	official_dimension	Item variant	itemVariant	The specific variation of a product. For example, XS, S, M, or L for size; or Red, Blue, Green, or Black for color. Populated by the item_variant parameter.
landingPage	official_dimension	Landing page	landingPage	The page path associated with the first pageview in a session.
landingPagePlusQueryString	official_dimension	Landing page + query string	landingPagePlusQueryString	The page path + query string associated with the first pageview in a session.
language	official_dimension	Language	language	The language setting of the user's browser or device. For example, English .
languageCode	official_dimension	Language code	languageCode	The language setting (ISO 639) of the user's browser or device. For example, en-us .
level	official_dimension	Level	level	The player's level in a game. Populated by the event parameter level .
linkClasses	official_dimension	Link classes	linkClasses	The HTML class attribute for an outbound link. For example if a user clicks a link <a class="center" href="www.youtube.com"> , this dimension will return center . Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter lin…
linkDomain	official_dimension	Link domain	linkDomain	The destination domain of the outbound link. For example if a user clicks a link <a href="www.youtube.com"> , this dimension will return youtube.com . Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_domain .
linkId	official_dimension	Link ID	linkId	The HTML ID attribute for an outbound link or file download. For example if a user clicks a link <a id="socialLinks" href="www.youtube.com"> , this dimension will return socialLinks . Automatically populated if Enhanced Measurement is enabled. Populated by th…
linkText	official_dimension	Link text	linkText	The link text of the file download. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter link_text .
linkUrl	official_dimension	Link URL	linkUrl	The full URL for an outbound link or file download. For example if a user clicks a link <a href="https://www.youtube.com/results?search_query=analytics"> , this dimension will return https://www.youtube.com/results?search_query=analytics . Automatically popul…
manualAdContent	official_dimension	Manual ad content	manualAdContent	The ad content attributed to the key event. Populated by the utm_content parameter.
manualCampaignId	official_dimension	Manual campaign ID	manualCampaignId	The manual Campaign ID that led to the key event. Identifies the manual campaign. Populated by utm_id URL parameter.
manualCampaignName	official_dimension	Manual campaign name	manualCampaignName	The manual Campaign Name that led to the key event. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs .
manualCreativeFormat	official_dimension	Manual creative format	manualCreativeFormat	The manual Creative Format that led to the key event. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
manualMarketingTactic	official_dimension	Manual marketing tactic	manualMarketingTactic	The manual Marketing Tactic that led to the key event. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
manualMedium	official_dimension	Manual medium	manualMedium	The manual Medium that led to the key event. The marketing medium used in the referral. For example, cpc . Populated by utm_medium URL parameter.
manualSource	official_dimension	Manual source	manualSource	The manual Source that led to the key event. The referrer. Populated by utm_source URL parameter.
manualSourceMedium	official_dimension	Manual source / medium	manualSourceMedium	The manual Source Medium that led to the key event. A combination of the source and medium.
manualSourcePlatform	official_dimension	Manual source platform	manualSourcePlatform	The manual Source Platform that led to the key event. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
manualTerm	official_dimension	Manual term	manualTerm	The term attributed to the key event. Populated by the utm_term parameter.
medium	official_dimension	Medium	medium	The medium attributed to the key event.
method	official_dimension	Method	method	The method by which an event was triggered. Populated by the event parameter method .
minute	official_dimension	Minute	minute	The two-digit minute of the hour that the event was logged. This dimension ranges from 0-59 and is reported in your property's timezone.
mobileDeviceBranding	official_dimension	Device brand	mobileDeviceBranding	Manufacturer or branded name (examples: Samsung, HTC, Verizon, T-Mobile).
mobileDeviceMarketingName	official_dimension	Device	mobileDeviceMarketingName	The branded device name (examples: Galaxy S10 or P30 Pro).
mobileDeviceModel	official_dimension	Mobile model	mobileDeviceModel	The mobile device model name (examples: iPhone X or SM-G950F).
month	official_dimension	Month	month	The month of the event, a two digit integer from 01 to 12.
newVsReturning	official_dimension	New / returning	newVsReturning	New users have 0 previous sessions, and returning users have 1 or more previous sessions. This dimension returns two values: new or returning .
nthDay	official_dimension	Nth day	nthDay	The number of days since the start of the date range.
nthHour	official_dimension	Nth hour	nthHour	The number of hours since the start of the date range. The starting hour is 0000.
nthMinute	official_dimension	Nth minute	nthMinute	The number of minutes since the start of the date range. The starting minute is 0000.
nthMonth	official_dimension	Nth month	nthMonth	The number of months since the start of a date range. The starting month is 0000.
nthWeek	official_dimension	Nth week	nthWeek	A number representing the number of weeks since the start of a date range.
nthYear	official_dimension	Nth year	nthYear	The number of years since the start of the date range. The starting year is 0000.
operatingSystem	official_dimension	Operating system	operatingSystem	The operating systems used by visitors to your app or website. Includes desktop and mobile operating systems such as Windows and Android.
operatingSystemVersion	official_dimension	OS version	operatingSystemVersion	The operating system versions used by visitors to your website or app. For example, Android 10's version is 10, and iOS 13.5.1's version is 13.5.1.
operatingSystemWithVersion	official_dimension	Operating system with version	operatingSystemWithVersion	The operating system and version. For example, Android 10 or Windows 7.
orderCoupon	official_dimension	Order coupon	orderCoupon	Code for the order-level coupon.
outbound	official_dimension	Outbound	outbound	Returns true if the link led to a site that is not a part of the property's domain. Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter outbound .
pageLocation	official_dimension	Page location	pageLocation	The protocol, hostname, page path, and query string for web pages visited; for example, the pageLocation portion of https://www.example.com/store/contact-us?query_string=true is https://www.example.com/store/contact-us?query_string=true . Populated by the eve…
pagePath	official_dimension	Page path	pagePath	The portion of the URL between the hostname and query string for web pages visited; for example, the pagePath portion of https://www.example.com/store/contact-us?query_string=true is /store/contact-us .
pagePathPlusQueryString	official_dimension	Page path + query string	pagePathPlusQueryString	The portion of the URL following the hostname for web pages visited; for example, the pagePathPlusQueryString portion of https://www.example.com/store/contact-us?query_string=true is /store/contact-us?query_string=true .
pageReferrer	official_dimension	Page referrer	pageReferrer	The full referring URL including the hostname and path. This referring URL is the user's previous URL and can be this website's domain or other domains. Populated by the event parameter page_referrer .
pageTitle	official_dimension	Page title	pageTitle	The web page titles used on your site.
percentScrolled	official_dimension	Percent scrolled	percentScrolled	The percentage down the page that the user has scrolled (for example, 90 ). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter percent_scrolled .
platform	official_dimension	Platform	platform	The platform on which your app or website ran; for example, web, iOS, or Android. To determine a stream's type in a report, use both platform and streamId.
platformDeviceCategory	official_dimension	Platform / device category	platformDeviceCategory	The platform and type of device on which your website or mobile app ran. (example: Android / mobile)
primaryChannelGroup	official_dimension	Primary channel group	primaryChannelGroup	The primary channel group attributed to the key event. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn more…
region	official_dimension	Region	region	The geographic region from which the user activity originated, derived from their IP address.
sa360AdGroupId	official_dimension	SA360 ad group ID	sa360AdGroupId	The SA360 Ad Group ID that led to the key event. Identifies the SA360 ad group.
sa360AdGroupName	official_dimension	SA360 ad group name	sa360AdGroupName	The SA360 Ad Group Name that led to the key event. SA360 Ad groups contain ads and keywords that relate to each other.
sa360CampaignId	official_dimension	SA360 campaign ID	sa360CampaignId	The SA360 Campaign ID that led to the key event. Identifies the SA360 campaign.
sa360CampaignName	official_dimension	SA360 campaign	sa360CampaignName	The SA360 Campaign Name that led to the key event. A SA360 campaign lets you organize your ads and define a goal for your advertising.
sa360CreativeFormat	official_dimension	SA360 creative format	sa360CreativeFormat	The SA360 Creative Format that led to the key event. The creative format is the specific layout or design of the advertisement used in a campaign.
sa360EngineAccountId	official_dimension	SA360 engine account ID	sa360EngineAccountId	The SA360 Engine Account ID that led to the key event. Identifies the SA360 engine account.
sa360EngineAccountName	official_dimension	SA360 engine account name	sa360EngineAccountName	The SA360 Engine Account Name that led to the key event. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account.
sa360EngineAccountType	official_dimension	SA360 engine account type	sa360EngineAccountType	The SA360 Engine Account Type that led to the key event. The type of engine used by the search engine account.
sa360KeywordText	official_dimension	SA360 keyword text	sa360KeywordText	The SA360 Keyword Text that led to the key event. The keywords that matched the search query.
sa360ManagerAccountId	official_dimension	SA360 manager account ID	sa360ManagerAccountId	The SA360 Manager Account ID that led to the key event. Identifies the SA360 manager account.
sa360ManagerAccountName	official_dimension	SA360 manager account name	sa360ManagerAccountName	The SA360 Manager Account Name that led to the key event. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
sa360Medium	official_dimension	SA360 medium	sa360Medium	The SA360 Medium that led to the key event. The payment mode used in ad buying. For example, cpc .
sa360Query	official_dimension	SA360 query	sa360Query	The SA360 Query that led to the key event. The search query typed by the user.
sa360Source	official_dimension	SA360 source	sa360Source	The SA360 Source that led to the key event. The search query happened on this site.
sa360SourceMedium	official_dimension	SA360 source / medium	sa360SourceMedium	The SA360 Source Medium that led to the key event. A combination of the source and medium.
screenResolution	official_dimension	Screen resolution	screenResolution	The screen resolution of the user's monitor. For example, 1920x1080.
searchTerm	official_dimension	Search term	searchTerm	The term searched by the user. For example if the user visits /some-page.html?q=some-term , this dimension returns some-term . Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter search_term .
sessionCampaignId	official_dimension	Session campaign ID	sessionCampaignId	The marketing campaign ID for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
sessionCampaignName	official_dimension	Session campaign	sessionCampaignName	The marketing campaign name for a session. Includes Google Ads Campaigns, Manual Campaigns, & other Campaigns.
sessionCm360AccountId	official_dimension	Session CM360 account ID	sessionCm360AccountId	The CM360 Account ID that led to the session. Identifies the CM360 account.
sessionCm360AccountName	official_dimension	Session CM360 account name	sessionCm360AccountName	The CM360 Account Name that led to the session. A CM360 account consists of advertisers, sites, campaigns, and user profiles.
sessionCm360AdvertiserId	official_dimension	Session CM360 advertiser ID	sessionCm360AdvertiserId	The CM360 Advertiser ID that led to the session. Identifies the CM360 advertiser.
sessionCm360AdvertiserName	official_dimension	Session CM360 advertiser name	sessionCm360AdvertiserName	The CM360 Advertiser Name that led to the session. A CM360 Advertiser contains a group of campaigns, creative assets, and other settings.
sessionCm360CampaignId	official_dimension	Session CM360 campaign ID	sessionCm360CampaignId	The CM360 Campaign ID that led to the session. Identifies the CM360 campaign.
sessionCm360CampaignName	official_dimension	Session CM360 campaign name	sessionCm360CampaignName	The CM360 Campaign Name that led to the session. A CM360 campaign can be configured to specify when your ads run, what landing pages are used, and other properties.
sessionCm360CreativeFormat	official_dimension	Session CM360 creative format	sessionCm360CreativeFormat	The CM360 Creative Format that led to the session. CM360 creative formats are also referred to as creative types.
sessionCm360CreativeId	official_dimension	Session CM360 creative ID	sessionCm360CreativeId	The CM360 Creative ID that led to the session. Identifies a CM360 creative.
sessionCm360CreativeName	official_dimension	Session CM360 creative name	sessionCm360CreativeName	The CM360 Creative Name that led to the session. The name given to a CM360 creative.
sessionCm360CreativeType	official_dimension	Session CM360 creative type	sessionCm360CreativeType	The CM360 Creative Type that led to the session. A category of CM360 creatives like 'Display' or 'Tracking'. To learn more, see manage creatives
sessionCm360CreativeTypeId	official_dimension	Session CM360 creative type ID	sessionCm360CreativeTypeId	The CM360 Creative Type ID that led to the session. Identifies a CM360 creative type.
sessionCm360CreativeVersion	official_dimension	Session CM360 creative version	sessionCm360CreativeVersion	The CM360 Creative Version that led to the session. The version number helps you keep track of multiple versions of your creative in your reports. If you upload a new asset to an existing creative, the version number is increased by one.
sessionCm360Medium	official_dimension	Session CM360 medium	sessionCm360Medium	The CM360 Medium that led to the session. The CM360 medium is also referred to as the placement cost structure.
sessionCm360PlacementCostStructure	official_dimension	Session CM360 placement cost structure	sessionCm360PlacementCostStructure	The CM360 Placement Cost Structure that led to the session. Placement cost structures regulate how media cost will be calculated. For example 'CPM'.
sessionCm360PlacementId	official_dimension	Session CM360 placement ID	sessionCm360PlacementId	The CM360 Placement ID that led to the session. Identifies a CM360 placement. A placement is the part of a website where your ad appears.
sessionCm360PlacementName	official_dimension	Session CM360 placement name	sessionCm360PlacementName	The CM360 Placement Name that led to the session. The given name for a CM360 placement. A placement is the part of a website where your ad appears.
sessionCm360RenderingId	official_dimension	Session CM360 rendering ID	sessionCm360RenderingId	The CM360 Rendering ID that led to the session. Identifies a CM360 creative.
sessionCm360SiteId	official_dimension	Session CM360 site ID	sessionCm360SiteId	The CM360 Site ID that led to the session. Identifies a CM360 site.
sessionCm360SiteName	official_dimension	Session CM360 site name	sessionCm360SiteName	The CM360 Site Name that led to the session. The CM360 Site name from which the ad space was purchased.
sessionCm360Source	official_dimension	Session CM360 source	sessionCm360Source	The CM360 Source that led to the session. The CM360 source is also referred to as the site name.
sessionCm360SourceMedium	official_dimension	Session CM360 source / medium	sessionCm360SourceMedium	The CM360 Source Medium that led to the session. A combination of the source and medium.
sessionDefaultChannelGroup	official_dimension	Session default channel group	sessionDefaultChannelGroup	The session's default channel group is based primarily on source and medium. An enumeration which includes Direct , Organic Search , Paid Social , Organic Social , Email , Affiliates , Referral , Paid Search , Video , and Display .
sessionDv360AdvertiserId	official_dimension	Session DV360 advertiser ID	sessionDv360AdvertiserId	The DV360 Advertiser ID that led to the session. Identifies the DV360 advertiser.
sessionDv360AdvertiserName	official_dimension	Session DV360 advertiser name	sessionDv360AdvertiserName	The DV360 Advertiser Name that led to the session. DV360 advertisers represent real-life businesses that run advertising campaigns.
sessionDv360CampaignId	official_dimension	Session DV360 campaign ID	sessionDv360CampaignId	The DV360 Campaign ID that led to the session. Identifies the DV360 campaign.
sessionDv360CampaignName	official_dimension	Session DV360 campaign name	sessionDv360CampaignName	The DV360 Campaign Name that led to the session. DV360 campaigns group together related insertion orders with a common business goal.
sessionDv360CreativeFormat	official_dimension	Session DV360 creative format	sessionDv360CreativeFormat	The DV360 Creative Format that led to the session. Also referred to as the creative type. For example, expandable, video, or native.
sessionDv360CreativeId	official_dimension	Session DV360 creative ID	sessionDv360CreativeId	The DV360 Creative ID that led to the session. Identifies the DV360 creative.
sessionDv360CreativeName	official_dimension	Session DV360 creative name	sessionDv360CreativeName	The DV360 Creative Name that led to the session. The name given to a DV360 creative.
sessionDv360ExchangeId	official_dimension	Session DV360 exchange ID	sessionDv360ExchangeId	The DV360 Exchange ID that led to the session. Identifies the DV360 exchange.
sessionDv360ExchangeName	official_dimension	Session DV360 exchange name	sessionDv360ExchangeName	The DV360 Exchange Name that led to the session. The DV360 ad exchange involved in the ad click. To learn more, see managing exchanges .
sessionDv360InsertionOrderId	official_dimension	Session DV360 insertion order ID	sessionDv360InsertionOrderId	The DV360 Insertion Order ID that led to the session. Identifies the DV360 insertion order.
sessionDv360InsertionOrderName	official_dimension	Session DV360 insertion order name	sessionDv360InsertionOrderName	The DV360 Insertion Order Name that led to the session. A DV360 insertion order contains a set of line items that are related to the same advertising campaign.
sessionDv360LineItemId	official_dimension	Session DV360 line item ID	sessionDv360LineItemId	The DV360 Line Item ID that led to the session. Identifies the DV360 line item.
sessionDv360LineItemName	official_dimension	Session DV360 line item name	sessionDv360LineItemName	The DV360 Line Item Name that led to the session. A DV360 line item bids on impressions and serves creatives to inventory sources.
sessionDv360Medium	official_dimension	Session DV360 medium	sessionDv360Medium	The DV360 Medium that led to the session. The billable outcome of the insertion order. For example, cpm .
sessionDv360PartnerId	official_dimension	Session DV360 partner ID	sessionDv360PartnerId	The DV360 Partner ID that led to the session. Identifies the DV360 partner.
sessionDv360PartnerName	official_dimension	Session DV360 partner name	sessionDv360PartnerName	The DV360 Partner Name that led to the session. DV360 partners represent agencies, trading desks, or large individual advertisers.
sessionDv360Source	official_dimension	Session DV360 source	sessionDv360Source	The DV360 Source that led to the session. The DV360 site name where your ad was displayed.
sessionDv360SourceMedium	official_dimension	Session DV360 source / medium	sessionDv360SourceMedium	The DV360 Source Medium that led to the session. A combination of the source and medium.
sessionGoogleAdsAccountName	official_dimension	Session Google Ads account name	sessionGoogleAdsAccountName	The Account name from Google Ads that led to the session. Corresponds to customer.descriptive_name in the Google Ads API.
sessionGoogleAdsAdGroupId	official_dimension	Session Google Ads ad group ID	sessionGoogleAdsAdGroupId	The Ad Group Id in Google Ads for a session.
sessionGoogleAdsAdGroupName	official_dimension	Session Google Ads ad group name	sessionGoogleAdsAdGroupName	The Ad Group Name in Google Ads for a session.
sessionGoogleAdsAdNetworkType	official_dimension	Session Google Ads ad network type	sessionGoogleAdsAdNetworkType	The advertising network that led to the session. An enumeration which includes Google search , Search partners , Google Display Network , Youtube Search , Youtube Videos , Cross-network , Social , and (universal campaign) .
sessionGoogleAdsCampaignId	official_dimension	Session Google Ads campaign ID	sessionGoogleAdsCampaignId	The Campaign ID for the Google Ads Campaign that led to this session.
sessionGoogleAdsCampaignName	official_dimension	Session Google Ads campaign	sessionGoogleAdsCampaignName	The Campaign name for the Google Ads Campaign that led to this session.
sessionGoogleAdsCampaignType	official_dimension	Session Google Ads campaign type	sessionGoogleAdsCampaignType	The campaign type for the Google Ads campaign that led to this session. Campaign types determine where customers see your ads and the settings and options available to you in Google Ads. Campaign type is an enumeration that includes: Search, Display, Shopping…
sessionGoogleAdsCreativeId	official_dimension	Session Google Ads creative ID	sessionGoogleAdsCreativeId	The ID of the Google Ads creative that led to a session on your website or app. Creative IDs identify individual ads.
sessionGoogleAdsCustomerId	official_dimension	Session Google Ads customer ID	sessionGoogleAdsCustomerId	The Customer ID from Google Ads that led to the session. Customer IDs in Google Ads uniquely identify Google Ads accounts.
sessionGoogleAdsKeyword	official_dimension	Session Google Ads keyword text	sessionGoogleAdsKeyword	The matched keyword that led to the session. Keywords are words or phrases describing your product or service that you choose to get your ad in front of the right customers. To learn more about Keywords, see Keywords: Definition .
sessionGoogleAdsQuery	official_dimension	Session Google Ads query	sessionGoogleAdsQuery	The search query that led to the session.
sessionManualAdContent	official_dimension	Session manual ad content	sessionManualAdContent	The ad content that led to a session. Populated by the utm_content parameter.
sessionManualCampaignId	official_dimension	Session manual campaign ID	sessionManualCampaignId	The manual Campaign ID that led to the session. Identifies the manual campaign. Populated by utm_id URL parameter.
sessionManualCampaignName	official_dimension	Session manual campaign name	sessionManualCampaignName	The manual Campaign Name that led to the session. The name of the manual campaign. Populated by utm_campaign URL parameter. To learn more, see Collect campaign data with custom URLs .
sessionManualCreativeFormat	official_dimension	Session manual creative format	sessionManualCreativeFormat	The manual Creative Format that led to the session. Identifies the creative format used in the ad. Populated by utm_creative_format URL parameter.
sessionManualMarketingTactic	official_dimension	Session manual marketing tactic	sessionManualMarketingTactic	The manual Marketing Tactic that led to the session. The targeting criteria applied to a campaign. For example, remarketing or prospecting. Populated by utm_marketing_tactic URL parameter.
sessionManualMedium	official_dimension	Session manual medium	sessionManualMedium	The manual Medium that led to the session. The marketing medium used in the referral. For example, cpc . Populated by utm_medium URL parameter.
sessionManualSource	official_dimension	Session manual source	sessionManualSource	The manual Source that led to the session. The referrer. Populated by utm_source URL parameter.
sessionManualSourceMedium	official_dimension	Session manual source / medium	sessionManualSourceMedium	The manual Source Medium that led to the session. A combination of the source and medium.
sessionManualSourcePlatform	official_dimension	Session manual source platform	sessionManualSourcePlatform	The manual Source Platform that led to the session. The platform responsible for directing traffic to a given Analytics property. Populated by utm_source_platform URL parameter.
sessionManualTerm	official_dimension	Session manual term	sessionManualTerm	The term that led to a session. Populated by the utm_term parameter.
sessionMedium	official_dimension	Session medium	sessionMedium	The medium that initiated a session on your website or app.
sessionPrimaryChannelGroup	official_dimension	Session primary channel group	sessionPrimaryChannelGroup	The primary channel group that led to the session. Primary channel groups are the channel groups used in standard reports in Google Analytics and serve as an active record of your property's data in alignment with channel grouping over time. To learn more, se…
sessionSa360AdGroupId	official_dimension	Session SA360 ad group ID	sessionSa360AdGroupId	The SA360 Ad Group ID that led to the session. Identifies the SA360 ad group.
sessionSa360AdGroupName	official_dimension	Session SA360 ad group name	sessionSa360AdGroupName	The SA360 Ad Group Name that led to the session. SA360 Ad groups contain ads and keywords that relate to each other.
sessionSa360CampaignId	official_dimension	Session SA360 campaign ID	sessionSa360CampaignId	The SA360 Campaign ID that led to the session. Identifies the SA360 campaign.
sessionSa360CampaignName	official_dimension	Session SA360 campaign	sessionSa360CampaignName	The SA360 Campaign Name that led to the session. A SA360 campaign lets you organize your ads and define a goal for your advertising.
sessionSa360CreativeFormat	official_dimension	Session SA360 creative format	sessionSa360CreativeFormat	The SA360 Creative Format that led to the session. The creative format is the specific layout or design of the advertisement used in a campaign.
sessionSa360EngineAccountId	official_dimension	Session SA360 engine account ID	sessionSa360EngineAccountId	The SA360 Engine Account ID that led to the session. Identifies the SA360 engine account.
sessionSa360EngineAccountName	official_dimension	Session SA360 engine account name	sessionSa360EngineAccountName	The SA360 Engine Account Name that led to the session. A SA360 engine account contains campaigns, ad groups, and other items from an advertising account.
sessionSa360EngineAccountType	official_dimension	Session SA360 engine account type	sessionSa360EngineAccountType	The SA360 Engine Account Type that led to the session. The type of engine used by the search engine account. For example, google ads , bing , or baidu .
sessionSa360Keyword	official_dimension	Session SA360 keyword text	sessionSa360Keyword	The SA360 Keyword Text that led to the session. The keywords that matched the search query.
sessionSa360ManagerAccountId	official_dimension	Session SA360 manager account ID	sessionSa360ManagerAccountId	The SA360 Manager Account ID that led to the session. Identifies the SA360 manager account.
sessionSa360ManagerAccountName	official_dimension	Session SA360 manager account name	sessionSa360ManagerAccountName	The SA360 Manager Account Name that led to the session. The top level of the Search Ads 360 account hierarchy and is used for administration and reporting across the lower-level sub-manager and client accounts.
sessionSa360Medium	official_dimension	Session SA360 medium	sessionSa360Medium	The SA360 Medium that led to the session. The payment mode used in ad buying. For example, cpc .
sessionSa360Query	official_dimension	Session SA360 query	sessionSa360Query	The SA360 Query that led to the session. The search query typed by the user.
sessionSa360Source	official_dimension	Session SA360 source	sessionSa360Source	The SA360 Source that led to the session. The search query happened on this site.
sessionSa360SourceMedium	official_dimension	Session SA360 source / medium	sessionSa360SourceMedium	The SA360 Source Medium that led to the session. A combination of the source and medium.
sessionSource	official_dimension	Session source	sessionSource	The source that initiated a session on your website or app.
sessionSourceMedium	official_dimension	Session source / medium	sessionSourceMedium	The combined values of the dimensions sessionSource and sessionMedium .
sessionSourcePlatform	official_dimension	Session source platform	sessionSourcePlatform	The source platform of the session's campaign. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
shippingTier	official_dimension	Shipping tier	shippingTier	The shipping tier selected for delivery of the purchased item. For example, Ground , Air , or Next-day . Populated by the shipping_tier event parameter.
signedInWithUserId	official_dimension	Signed in with user ID	signedInWithUserId	The string yes if the user signed in with the User-ID feature. To learn more about User-ID, see Measure activity across platforms with User-ID .
source	official_dimension	Source	source	The source attributed to the key event.
sourceMedium	official_dimension	Source / medium	sourceMedium	The combined values of the dimensions source and medium .
sourcePlatform	official_dimension	Source platform	sourcePlatform	The source platform of the key event's campaign. Don't depend on this field returning Manual for traffic that uses UTMs; this field will update from returning Manual to returning (not set) for an upcoming feature launch.
streamId	official_dimension	Stream ID	streamId	The numeric data stream identifier for your app or website.
streamName	official_dimension	Stream name	streamName	The data stream name for your app or website.
testDataFilterId	official_dimension	Test data filter ID	testDataFilterId	The numeric identifier of a data filter in testing state. You use data filters to include or exclude event data from your reports based on event-parameter values. To learn more, see Data filters .
testDataFilterName	official_dimension	Test data filter name	testDataFilterName	The name of data filters in testing state. You use data filters to include or exclude event data from your reports based on event-parameter values. To learn more, see Data filters .
transactionId	official_dimension	Transaction ID	transactionId	The ID of the ecommerce transaction.
unifiedPagePathScreen	official_dimension	Page path and screen class	unifiedPagePathScreen	The page path (web) or screen class (app) on which the event was logged.
unifiedPageScreen	official_dimension	Page path + query string and screen class	unifiedPageScreen	The page path and query string (web) or screen class (app) on which the event was logged.
unifiedScreenClass	official_dimension	Page title and screen class	unifiedScreenClass	The page title (web) or screen class (app) on which the event was logged.
unifiedScreenName	official_dimension	Page title and screen name	unifiedScreenName	The page title (web) or screen name (app) on which the event was logged.
userAgeBracket	official_dimension	Age	userAgeBracket	User age brackets.
userGender	official_dimension	Gender	userGender	User gender.
videoProvider	official_dimension	Video provider	videoProvider	The source of the video (for example, youtube ). Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_provider .
videoTitle	official_dimension	Video title	videoTitle	The title of the video. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_title .
videoUrl	official_dimension	Video URL	videoUrl	The URL of the video. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter video_url .
virtualCurrencyName	official_dimension	Virtual currency name	virtualCurrencyName	The name of a virtual currency with which the user is interacting. Such as spending or purchasing gems in a game. Populated by the virtual_currency_name event parameter.
visible	official_dimension	Visible	visible	Returns true if the content is visible. Automatically populated for embedded videos if Enhanced Measurement is enabled. Populated by the event parameter visible .
week	official_dimension	Week	week	The week of the event, a two-digit number from 01 to 53. Each week starts on Sunday. January 1st is always in week 01. The first and last week of the year have fewer than 7 days in most years. Weeks other than the first and the last week of the year always ha…
year	official_dimension	Year	year	The four-digit year of the event. For example, 2020 or 2024.
yearMonth	official_dimension	Year month	yearMonth	The combined values of year and month. Example values include 202212 or 202301.
yearWeek	official_dimension	Year week	yearWeek	The combined values of year and week. Example values include 202253 or 202301.
customEvent:parameter_name	official_dimension	Event-scoped Custom Dimension for parameter_name customEvent:parameter_name[eve…	customEvent:parameter_name	Event-scoped Custom Dimension for parameter_name if registered before October 2020
customUser:parameter_name	official_dimension	User-scoped Custom Dimension for parameter_name customItem:parameter_name	customUser:parameter_name	Item-scoped Custom Dimension for parameter_name
sessionCustomChannelGroup:custom_channel_id	official_dimension	The custom channel that led to this session. firstUserCustomChannelGroup:custom…	sessionCustomChannelGroup:custom_channel_id	The custom channel that first acquired this user.
active1DayUsers	official_metric	1-day active users	active1DayUsers	The number of distinct active users on your site or app within a 1 day period. The 1 day period includes the last day in the report's date range. Note: this is the same as Active Users.
active28DayUsers	official_metric	28-day active users	active28DayUsers	The number of distinct active users on your site or app within a 28 day period. The 28 day period includes the last day in the report's date range.
active7DayUsers	official_metric	7-day active users	active7DayUsers	The number of distinct active users on your site or app within a 7 day period. The 7 day period includes the last day in the report's date range.
activeUsers	official_metric	Active users	activeUsers	The number of distinct users who visited your site or app.
adUnitExposure	official_metric	Ad unit exposure	adUnitExposure	The time that an ad unit was exposed to a user, in milliseconds.
addToCarts	official_metric	Add to carts	addToCarts	The number of times users added items to their shopping carts.
advertiserAdClicks	official_metric	Ads clicks	advertiserAdClicks	Total number of times users have clicked on an ad to reach the property. Includes clicks from linked integrations like linked Search Ads 360 advertisers. Also includes uploaded clicks from data import.
advertiserAdCost	official_metric	Ads cost	advertiserAdCost	The total amount you paid for your ads. Includes costs from linked integrations like linked Google Ads accounts. Also includes uploaded cost from data import; to learn more, see Import cost data .
advertiserAdCostPerClick	official_metric	Ads cost per click	advertiserAdCostPerClick	Ads cost per click is ad cost divided by ad clicks and is often abbreviated CPC.
advertiserAdCostPerKeyEvent	official_metric	Cost per key event	advertiserAdCostPerKeyEvent	Cost per key event is ad cost divided by key events.
advertiserAdImpressions	official_metric	Ads impressions	advertiserAdImpressions	The total number of impressions. Includes impressions from linked integrations like linked Display & Video 360 advertisers. Also includes uploaded impressions from data import.
averagePurchaseRevenue	official_metric	Average purchase revenue	averagePurchaseRevenue	The average purchase revenue in the transaction group of events.
averagePurchaseRevenuePerPayingUser	official_metric	ARPPU	averagePurchaseRevenuePerPayingUser	Average revenue per paying user (ARPPU) is the total purchase revenue per active user that logged a purchase event. The summary metric is for the time period selected.
averagePurchaseRevenuePerUser	official_metric	Average purchase revenue per user	averagePurchaseRevenuePerUser	The average purchase revenue per active user is the total purchase revenue per active user that logged any event. The summary metric is for the time period selected.
averageRevenuePerUser	official_metric	ARPU	averageRevenuePerUser	Average revenue per active user (ARPU). The summary metric is for the time period selected. ARPU uses Total Revenue and includes AdMob estimated earnings.
averageSessionDuration	official_metric	Average session duration	averageSessionDuration	The average duration (in seconds) of users` sessions.
bounceRate	official_metric	Bounce rate	bounceRate	The percentage of sessions that were not engaged ((Sessions Minus Engaged sessions) divided by Sessions). This metric is returned as a fraction; for example, 0.2761 means 27.61% of sessions were bounces.
cartToViewRate	official_metric	Cart-to-view rate	cartToViewRate	The number of users who added a product(s) to their cart divided by the number of users who viewed the same product(s). This metric is returned as a fraction; for example, 0.1132 means 11.32% of users who viewed a product also added the same product to their…
checkouts	official_metric	Checkouts	checkouts	The number of times users started the checkout process. This metric counts the occurrence of the begin_checkout event.
cohortActiveUsers	official_metric	Cohort active users	cohortActiveUsers	The number of users in the cohort who are active in the time window corresponding to the cohort nth day/week/month. For example in the row where cohortNthWeek = 0001, this metric is the number of users (in the cohort) who are active in week 1.
cohortTotalUsers	official_metric	Cohort total users	cohortTotalUsers	The total number of users in the cohort. This metric is the same value in every row of the report for each cohort. Because cohorts are defined by a shared acquisition date, cohortTotalUsers is the same as cohortActiveUsers for the cohort's selection date rang…
crashAffectedUsers	official_metric	Crash-affected users	crashAffectedUsers	The number of users that logged a crash in this row of the report. For example if the report is time series by date, this metrics reports total users with at least one crash on this date. Crashes are events with the name "app_exception".
crashFreeUsersRate	official_metric	Crash-free users rate	crashFreeUsersRate	The number of users without crash events (in this row of the report) divided by the total number of users. This metric is returned as a fraction; for example, 0.9243 means 92.43% of users were crash-free.
dauPerMau	official_metric	DAU / MAU	dauPerMau	The rolling percent of 30-day active users who are also 1-day active users. This metric is returned as a fraction; for example, 0.113 means 11.3% of 30-day active users were also 1-day active users.
dauPerWau	official_metric	DAU / WAU	dauPerWau	The rolling percent of 7-day active users who are also 1-day active users. This metric is returned as a fraction; for example, 0.082 means 8.2% of 7-day active users were also 1-day active users.
ecommercePurchases	official_metric	Ecommerce purchases	ecommercePurchases	The number of times users completed a purchase. This metric counts purchase events; this metric does not count in_app_purchase and subscription events.
engagedSessions	official_metric	Engaged sessions	engagedSessions	The number of sessions that lasted longer than 10 seconds, or had a key event, or had 2 or more screen views.
engagementRate	official_metric	Engagement rate	engagementRate	The percentage of engaged sessions (Engaged sessions divided by Sessions). This metric is returned as a fraction; for example, 0.7239 means 72.39% of sessions were engaged sessions.
eventCount	official_metric	Event count	eventCount	The count of events.
eventCountPerUser	official_metric	Event count per user	eventCountPerUser	The average number of events per user (Event count divided by Active users).
eventValue	official_metric	Event value	eventValue	The sum of the event parameter named value .
eventsPerSession	official_metric	Events per session	eventsPerSession	The average number of events per session (Event count divided by Sessions).
firstTimePurchaserRate	official_metric	First-time purchaser rate	firstTimePurchaserRate	The percentage of active users who made their first purchase. This metric is returned as a fraction; for example, 0.092 means 9.2% of active users were first time purchasers.
firstTimePurchasers	official_metric	First time purchasers	firstTimePurchasers	The number of users that completed their first purchase event.
firstTimePurchasersPerNewUser	official_metric	First-time purchasers per new user	firstTimePurchasersPerNewUser	The average number of first time purchasers per new user.
grossItemRevenue	official_metric	Gross item revenue	grossItemRevenue	The total revenue from items only. Gross item revenue is the product of its price and quantity. Item revenue excludes tax and shipping values; tax & shipping values are specified at the event and not item level. Gross item revenue does not include refunds.
grossPurchaseRevenue	official_metric	Gross purchase revenue	grossPurchaseRevenue	The sum of revenue from purchases made in your app or site. Gross purchase revenue sums the revenue for these events: purchase , ecommerce_purchase , in_app_purchase , app_store_subscription_convert , and app_store_subscription_renew . Purchase revenue is spe…
itemDiscountAmount	official_metric	Item discount amount	itemDiscountAmount	The monetary value of item discounts in eCommerce events. This metric is populated in tagging by the discount item parameter.
itemListClickEvents	official_metric	Item-list click events	itemListClickEvents	The number of times users clicked an item when it appeared in a list. This metric counts the occurrence of the select_item event.
itemListClickThroughRate	official_metric	Item list click through rate	itemListClickThroughRate	The number of users who selected a list(s) divided by the number of users who viewed the same list(s). This metric is returned as a fraction; for example, 0.2145 means 21.45% of users who viewed a list also selected the same list.
itemListViewEvents	official_metric	Item-list view events	itemListViewEvents	The number of times the item list was viewed. This metric counts the occurrence of the view_item_list event.
itemPromotionClickThroughRate	official_metric	Item promotion click through rate	itemPromotionClickThroughRate	The number of users who selected a promotion(s) divided by the number of users who viewed the same promotion(s). This metric is returned as a fraction; for example, 0.1382 means 13.82% of users who viewed a promotion also selected the promotion.
itemRefundAmount	official_metric	Item refund amount	itemRefundAmount	Item refund amount is the total refunded transaction revenue from items only. Item refund amount is the product of price and quantity for the refund event.
itemRevenue	official_metric	Item revenue	itemRevenue	The total revenue from purchases minus refunded transaction revenue from items only. Item revenue is the product of its price and quantity. Item revenue excludes tax and shipping values; tax & shipping values are specified at the event and not item level.
itemViewEvents	official_metric	Item view events	itemViewEvents	The number of times the item details were viewed. The metric counts the occurrence of the view_item event.
itemsAddedToCart	official_metric	Items added to cart	itemsAddedToCart	The number of units added to cart for a single item. This metric counts the quantity of items in add_to_cart events.
itemsCheckedOut	official_metric	Items checked out	itemsCheckedOut	The number of units checked out for a single item. This metric counts the quantity of items in begin_checkout events.
itemsClickedInList	official_metric	Items clicked in list	itemsClickedInList	The number of units clicked in list for a single item. This metric counts the quantity of items in select_item events.
itemsClickedInPromotion	official_metric	Items clicked in promotion	itemsClickedInPromotion	The number of units clicked in promotion for a single item. This metric counts the quantity of items in select_promotion events.
itemsPurchased	official_metric	Items purchased	itemsPurchased	The number of units for a single item included in purchase events. This metric counts the quantity of items in purchase events.
itemsViewed	official_metric	Items viewed	itemsViewed	The number of units viewed for a single item. This metric counts the quantity of items in view_item events.
itemsViewedInList	official_metric	Items viewed in list	itemsViewedInList	The number of units viewed in list for a single item. This metric counts the quantity of items in view_item_list events.
itemsViewedInPromotion	official_metric	Items viewed in promotion	itemsViewedInPromotion	The number of units viewed in promotion for a single item. This metric counts the quantity of items in view_promotion events.
keyEvents	official_metric	Key events	keyEvents	The count of key events. Marking an event as a key event affects reports from time of creation. It doesn't change historic data. You can mark any event as key in Google Analytics, and some events (such as first_open or purchase ) are marked as key events by d…
newUsers	official_metric	New users	newUsers	The number of users who interacted with your site or launched your app for the first time (event triggered: first_open or first_visit).
organicGoogleSearchAveragePosition	official_metric	Organic Google Search average position	organicGoogleSearchAveragePosition	The average ranking of your website URLs for the query reported from Search Console. For example, if your site's URL appears at position 3 for one query and position 7 for another query, the average position would be (3+7)/2, or 5. This metric requires an act…
organicGoogleSearchClickThroughRate	official_metric	Organic Google Search click through rate	organicGoogleSearchClickThroughRate	The organic Google Search click through rate reported from Search Console. Click through rate is clicks per impression. This metric is returned as a fraction; for example, 0.0588 means about 5.88% of impressions resulted in a click. This metric requires an ac…
organicGoogleSearchClicks	official_metric	Organic Google Search clicks	organicGoogleSearchClicks	The number of organic Google Search clicks reported from Search Console. This metric requires an active Search Console link.
organicGoogleSearchImpressions	official_metric	Organic Google Search impressions	organicGoogleSearchImpressions	The number of organic Google Search impressions reported from Search Console. This metric requires an active Search Console link.
promotionClicks	official_metric	Promotion clicks	promotionClicks	The number of times an item promotion was clicked. This metric counts the occurrence of the select_promotion event.
promotionViews	official_metric	Promotion views	promotionViews	The number of times an item promotion was viewed. This metric counts the occurrence of the view_promotion event.
publisherAdClicks	official_metric	Publisher ad clicks	publisherAdClicks	The number of ad_click events.
publisherAdImpressions	official_metric	Publisher ad impressions	publisherAdImpressions	The number of ad_impression events.
purchaseRevenue	official_metric	Purchase revenue	purchaseRevenue	The sum of revenue from purchases minus refunded transaction revenue made in your app or site. Purchase revenue sums the revenue for these events: purchase , ecommerce_purchase , in_app_purchase , app_store_subscription_convert , and app_store_subscription_re…
purchaseToViewRate	official_metric	Purchase-to-view rate	purchaseToViewRate	The number of users who purchased a product(s) divided by the number of users who viewed the same product(s). This metric is returned as a fraction; for example, 0.128 means 12.8% of users that viewed a product(s) also purchased the same product(s).
purchaserRate	official_metric	Purchaser rate	purchaserRate	The percentage of active users who made 1 or more purchase transactions. This metric is returned as a fraction; for example, 0.412 means 41.2% of users were purchasers.
refundAmount	official_metric	Refund amount	refundAmount	The total refunded transaction revenues. Refund amount sums refunded revenue for the refund and app_store_refund events.
returnOnAdSpend	official_metric	Return on ad spend	returnOnAdSpend	Return On Ad Spend (ROAS) is total revenue divided by advertiser ad cost.
screenPageViews	official_metric	Views	screenPageViews	The number of app screens or web pages your users viewed. Repeated views of a single page or screen are counted. (screen_view + page_view events).
screenPageViewsPerSession	official_metric	Views per session	screenPageViewsPerSession	The number of app screens or web pages your users viewed per session. Repeated views of a single page or screen are counted. (screen_view + page_view events) / sessions.
screenPageViewsPerUser	official_metric	Views per user	screenPageViewsPerUser	The number of app screens or web pages your users viewed per active user. Repeated views of a single page or screen are counted. (screen_view + page_view events) / active users.
scrolledUsers	official_metric	Scrolled users	scrolledUsers	The number of unique users who scrolled down at least 90% of the page.
sessionKeyEventRate	official_metric	Session key event rate	sessionKeyEventRate	The percentage of sessions in which any key event was triggered.
sessions	official_metric	Sessions	sessions	The number of sessions that began on your site or app (event triggered: session_start).
sessionsPerUser	official_metric	Sessions per user	sessionsPerUser	The average number of sessions per user (Sessions divided by Active Users).
shippingAmount	official_metric	Shipping amount	shippingAmount	Shipping amount associated with a transaction. Populated by the shipping event parameter.
taxAmount	official_metric	Tax amount	taxAmount	Tax amount associated with a transaction. Populated by the tax event parameter.
totalAdRevenue	official_metric	Total ad revenue	totalAdRevenue	The total advertising revenue from both Admob and third-party sources.
totalPurchasers	official_metric	Total purchasers	totalPurchasers	The number of users that logged purchase events for the time period selected.
totalRevenue	official_metric	Total revenue	totalRevenue	The sum of revenue from purchases, subscriptions, and advertising (Purchase revenue plus Subscription revenue plus Ad revenue) minus refunded transaction revenue.
totalUsers	official_metric	Total users	totalUsers	The number of distinct users who have logged at least one event, regardless of whether the site or app was in use when that event was logged.
transactions	official_metric	Transactions	transactions	The count of transaction events with purchase revenue. Transaction events are in_app_purchase, ecommerce_purchase, purchase, app_store_subscription_renew, app_store_subscription_convert, and refund.
transactionsPerPurchaser	official_metric	Transactions per purchaser	transactionsPerPurchaser	The average number of transactions per purchaser.
userEngagementDuration	official_metric	User engagement	userEngagementDuration	The total amount of time (in seconds) your website or app was in the foreground of users` devices.
userKeyEventRate	official_metric	User key event rate	userKeyEventRate	The percentage of users who triggered any key event.
wauPerMau	official_metric	WAU / MAU	wauPerMau	The rolling percent of 30-day active users who are also 7-day active users. This metric is returned as a fraction; for example, 0.234 means 23.4% of 30-day active users were also 7-day active users.
countCustomEvent:parameter_name	official_metric	The number of occurrences of an Event-scoped Custom Metric for parameter_name K…	countCustomEvent:parameter_name	The percentage of sessions in which a specific key event event was triggered.
metadata.dimensions_metrics	dynamic_catalog	プロパティ別dimension/metric一覧	properties/{property}/metadata	GA4 Metadata APIで、接続プロパティごとに利用可能なカスタムdimension/metricを動的に取得できます。

サーチコンソール

分析・SEO / Google OAuth

提供中

検索クエリ、ページ、クリック、表示回数、CTR、平均掲載順位を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_search_console_sites	なし	site_url / permission	接続済みサイトを一覧化する
run_search_console_query	start_date, end_date, dimensions, search_type, site_url	clicks / impressions / ctr / position	検索パフォーマンスを分解して取得する

フィールド

ID	型	表示名	媒体側API名	説明
date	official_dimension	日付	searchanalytics.query	Search Analytics APIのdimensionです。
query	official_dimension	検索クエリ	searchanalytics.query	Search Analytics APIのdimensionです。
page	official_dimension	ページ	searchanalytics.query	Search Analytics APIのdimensionです。
country	official_dimension	国	searchanalytics.query	Search Analytics APIのdimensionです。
device	official_dimension	デバイス	searchanalytics.query	Search Analytics APIのdimensionです。
searchAppearance	official_dimension	検索での見え方	searchanalytics.query	Search Analytics APIのdimensionです。
clicks	official_metric	クリック	searchanalytics.query	Search Analytics APIの行メトリクスです。
impressions	official_metric	表示回数	searchanalytics.query	Search Analytics APIの行メトリクスです。
ctr	official_metric	CTR	searchanalytics.query	Search Analytics APIの行メトリクスです。
position	official_metric	平均掲載順位	searchanalytics.query	Search Analytics APIの行メトリクスです。
SearchAnalyticsQueryRequest.dimensions	api_schema_field	Dimensions	SearchAnalyticsQueryRequest.dimensions (array)	[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.
SearchAnalyticsQueryRequest.startDate	api_schema_field	Start Date	SearchAnalyticsQueryRequest.startDate (string)	[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.
SearchAnalyticsQueryRequest.dimensionFilterGroups	api_schema_field	Dimension Filter Groups	SearchAnalyticsQueryRequest.dimensionFilterGroups (array)	[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it.
SearchAnalyticsQueryRequest.dimensionFilterGroups.groupType	api_schema_field	Group Type	ApiDimensionFilterGroup.groupType (string)	ApiDimensionFilterGroup.groupType schema field
SearchAnalyticsQueryRequest.dimensionFilterGroups.filters	api_schema_field	Filters	ApiDimensionFilterGroup.filters (array)	ApiDimensionFilterGroup.filters schema field
SearchAnalyticsQueryRequest.dimensionFilterGroups.filters.operator	api_schema_field	Operator	ApiDimensionFilter.operator (string)	ApiDimensionFilter.operator schema field
SearchAnalyticsQueryRequest.dimensionFilterGroups.filters.dimension	api_schema_field	Dimension	ApiDimensionFilter.dimension (string)	ApiDimensionFilter.dimension schema field
SearchAnalyticsQueryRequest.dimensionFilterGroups.filters.expression	api_schema_field	Expression	ApiDimensionFilter.expression (string)	ApiDimensionFilter.expression schema field
SearchAnalyticsQueryRequest.rowLimit	api_schema_field	Row Limit	SearchAnalyticsQueryRequest.rowLimit (integer)	[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive).
SearchAnalyticsQueryRequest.searchType	api_schema_field	Search Type	SearchAnalyticsQueryRequest.searchType (string)	[Optional; Default is \"web\"] The search type to filter for.
SearchAnalyticsQueryRequest.type	api_schema_field	Type	SearchAnalyticsQueryRequest.type (string)	Optional. [Optional; Default is \"web\"] Type of report: search type, or either Discover or Gnews.
SearchAnalyticsQueryRequest.endDate	api_schema_field	End Date	SearchAnalyticsQueryRequest.endDate (string)	[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.
SearchAnalyticsQueryRequest.startRow	api_schema_field	Start Row	SearchAnalyticsQueryRequest.startRow (integer)	[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.
SearchAnalyticsQueryRequest.aggregationType	api_schema_field	Aggregation Type	SearchAnalyticsQueryRequest.aggregationType (string)	[Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can agg…
SearchAnalyticsQueryRequest.dataState	api_schema_field	Data State	SearchAnalyticsQueryRequest.dataState (string)	The data state to be fetched, can be full or all, the latter including full and partial data.
SearchAnalyticsQueryResponse.rows	api_schema_field	Rows	SearchAnalyticsQueryResponse.rows (array)	A list of rows grouped by the key values in the order given in the query.
SearchAnalyticsQueryResponse.rows.clicks	api_schema_field	Clicks	ApiDataRow.clicks (number)	ApiDataRow.clicks schema field
SearchAnalyticsQueryResponse.rows.impressions	api_schema_field	Impressions	ApiDataRow.impressions (number)	ApiDataRow.impressions schema field
SearchAnalyticsQueryResponse.rows.position	api_schema_field	Position	ApiDataRow.position (number)	ApiDataRow.position schema field
SearchAnalyticsQueryResponse.rows.ctr	api_schema_field	Ctr	ApiDataRow.ctr (number)	ApiDataRow.ctr schema field
SearchAnalyticsQueryResponse.rows.keys	api_schema_field	Keys	ApiDataRow.keys (array)	ApiDataRow.keys schema field
SearchAnalyticsQueryResponse.metadata	api_schema_field	Metadata	SearchAnalyticsQueryResponse.metadata (object)	An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation.
SearchAnalyticsQueryResponse.metadata.firstIncompleteDate	api_schema_field	First Incomplete Date	Metadata.firstIncompleteDate (string)	The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is "`all`", data is grouped by "`DATE`", and the requ…
SearchAnalyticsQueryResponse.metadata.firstIncompleteHour	api_schema_field	First Incomplete Hour	Metadata.firstIncompleteHour (string)	The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+\|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is "`hourly_all`", data is g…
SearchAnalyticsQueryResponse.responseAggregationType	api_schema_field	Response Aggregation Type	SearchAnalyticsQueryResponse.responseAggregationType (string)	How the results were aggregated.
ApiDataRow.clicks	api_schema_field	Clicks	ApiDataRow.clicks (number)	ApiDataRow.clicks schema field
ApiDataRow.impressions	api_schema_field	Impressions	ApiDataRow.impressions (number)	ApiDataRow.impressions schema field
ApiDataRow.position	api_schema_field	Position	ApiDataRow.position (number)	ApiDataRow.position schema field
ApiDataRow.ctr	api_schema_field	Ctr	ApiDataRow.ctr (number)	ApiDataRow.ctr schema field
ApiDataRow.keys	api_schema_field	Keys	ApiDataRow.keys (array)	ApiDataRow.keys schema field
SitesListResponse.siteEntry	api_schema_field	Site Entry	SitesListResponse.siteEntry (array)	Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
SitesListResponse.siteEntry.siteUrl	api_schema_field	Site Url	WmxSite.siteUrl (string)	The URL of the site.
SitesListResponse.siteEntry.permissionLevel	api_schema_field	Permission Level	WmxSite.permissionLevel (string)	The user's permission level for the site.
WmxSite.siteUrl	api_schema_field	Site Url	WmxSite.siteUrl (string)	The URL of the site.
WmxSite.permissionLevel	api_schema_field	Permission Level	WmxSite.permissionLevel (string)	The user's permission level for the site.
SitemapsListResponse.sitemap	api_schema_field	Sitemap	SitemapsListResponse.sitemap (array)	Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).
SitemapsListResponse.sitemap.isPending	api_schema_field	Is Pending	WmxSitemap.isPending (boolean)	If true, the sitemap has not been processed.
SitemapsListResponse.sitemap.path	api_schema_field	Path	WmxSitemap.path (string)	The url of the sitemap.
SitemapsListResponse.sitemap.warnings	api_schema_field	Warnings	WmxSitemap.warnings (string)	Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
SitemapsListResponse.sitemap.type	api_schema_field	Type	WmxSitemap.type (string)	The type of the sitemap. For example: `rssFeed`.
SitemapsListResponse.sitemap.lastDownloaded	api_schema_field	Last Downloaded	WmxSitemap.lastDownloaded (string)	Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
SitemapsListResponse.sitemap.errors	api_schema_field	Errors	WmxSitemap.errors (string)	Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
SitemapsListResponse.sitemap.lastSubmitted	api_schema_field	Last Submitted	WmxSitemap.lastSubmitted (string)	Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
SitemapsListResponse.sitemap.contents	api_schema_field	Contents	WmxSitemap.contents (array)	The various content types in the sitemap.
SitemapsListResponse.sitemap.contents.type	api_schema_field	Type	WmxSitemapContent.type (string)	The specific type of content in this sitemap. For example: `web`.
SitemapsListResponse.sitemap.contents.submitted	api_schema_field	Submitted	WmxSitemapContent.submitted (string)	The number of URLs in the sitemap (of the content type).
SitemapsListResponse.sitemap.contents.indexed	api_schema_field	Indexed	WmxSitemapContent.indexed (string)	Deprecated; do not use.
SitemapsListResponse.sitemap.isSitemapsIndex	api_schema_field	Is Sitemaps Index	WmxSitemap.isSitemapsIndex (boolean)	If true, the sitemap is a collection of sitemaps.
WmxSitemap.isPending	api_schema_field	Is Pending	WmxSitemap.isPending (boolean)	If true, the sitemap has not been processed.
WmxSitemap.path	api_schema_field	Path	WmxSitemap.path (string)	The url of the sitemap.
WmxSitemap.warnings	api_schema_field	Warnings	WmxSitemap.warnings (string)	Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
WmxSitemap.type	api_schema_field	Type	WmxSitemap.type (string)	The type of the sitemap. For example: `rssFeed`.
WmxSitemap.lastDownloaded	api_schema_field	Last Downloaded	WmxSitemap.lastDownloaded (string)	Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
WmxSitemap.errors	api_schema_field	Errors	WmxSitemap.errors (string)	Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
WmxSitemap.lastSubmitted	api_schema_field	Last Submitted	WmxSitemap.lastSubmitted (string)	Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
WmxSitemap.contents	api_schema_field	Contents	WmxSitemap.contents (array)	The various content types in the sitemap.
WmxSitemap.contents.type	api_schema_field	Type	WmxSitemapContent.type (string)	The specific type of content in this sitemap. For example: `web`.
WmxSitemap.contents.submitted	api_schema_field	Submitted	WmxSitemapContent.submitted (string)	The number of URLs in the sitemap (of the content type).
WmxSitemap.contents.indexed	api_schema_field	Indexed	WmxSitemapContent.indexed (string)	Deprecated; do not use.
WmxSitemap.isSitemapsIndex	api_schema_field	Is Sitemaps Index	WmxSitemap.isSitemapsIndex (boolean)	If true, the sitemap is a collection of sitemaps.
UrlInspectionResult.indexStatusResult	api_schema_field	Index Status Result	UrlInspectionResult.indexStatusResult (object)	Result of the index status analysis.
UrlInspectionResult.indexStatusResult.googleCanonical	api_schema_field	Google Canonical	IndexStatusInspectionResult.googleCanonical (string)	The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.
UrlInspectionResult.indexStatusResult.indexingState	api_schema_field	Indexing State	IndexStatusInspectionResult.indexingState (string)	Whether or not the page blocks indexing through a noindex rule.
UrlInspectionResult.indexStatusResult.userCanonical	api_schema_field	User Canonical	IndexStatusInspectionResult.userCanonical (string)	The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.
UrlInspectionResult.indexStatusResult.referringUrls	api_schema_field	Referring Urls	IndexStatusInspectionResult.referringUrls (array)	URLs that link to the inspected URL, directly and indirectly.
UrlInspectionResult.indexStatusResult.crawledAs	api_schema_field	Crawled As	IndexStatusInspectionResult.crawledAs (string)	Primary crawler that was used by Google to crawl your site.
UrlInspectionResult.indexStatusResult.lastCrawlTime	api_schema_field	Last Crawl Time	IndexStatusInspectionResult.lastCrawlTime (string)	Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.
UrlInspectionResult.indexStatusResult.verdict	api_schema_field	Verdict	IndexStatusInspectionResult.verdict (string)	High level verdict about whether the URL is indexed (indexed status), or can be indexed (live inspection).
UrlInspectionResult.indexStatusResult.pageFetchState	api_schema_field	Page Fetch State	IndexStatusInspectionResult.pageFetchState (string)	Whether or not Google could retrieve the page from your server. Equivalent to ["page fetch"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.
UrlInspectionResult.indexStatusResult.sitemap	api_schema_field	Sitemap	IndexStatusInspectionResult.sitemap (array)	Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.
UrlInspectionResult.indexStatusResult.robotsTxtState	api_schema_field	Robots Txt State	IndexStatusInspectionResult.robotsTxtState (string)	Whether or not the page is blocked to Google by a robots.txt rule.
UrlInspectionResult.indexStatusResult.coverageState	api_schema_field	Coverage State	IndexStatusInspectionResult.coverageState (string)	Could Google find and index the page. More details about page indexing appear in 'indexing_state'.
UrlInspectionResult.richResultsResult	api_schema_field	Rich Results Result	UrlInspectionResult.richResultsResult (object)	Result of the Rich Results analysis. Absent if there are no rich results found.
UrlInspectionResult.richResultsResult.verdict	api_schema_field	Verdict	RichResultsInspectionResult.verdict (string)	High-level rich results inspection result for this URL.
UrlInspectionResult.richResultsResult.detectedItems	api_schema_field	Detected Items	RichResultsInspectionResult.detectedItems (array)	A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.
UrlInspectionResult.richResultsResult.detectedItems.items	api_schema_field	Items	DetectedItems.items (array)	List of Rich Results items.
UrlInspectionResult.richResultsResult.detectedItems.items.issues	api_schema_field	Issues	Item.issues (array)	A list of zero or more rich result issues found for this instance.
UrlInspectionResult.richResultsResult.detectedItems.items.name	api_schema_field	Name	Item.name (string)	The user-provided name of this item.
UrlInspectionResult.richResultsResult.detectedItems.richResultType	api_schema_field	Rich Result Type	DetectedItems.richResultType (string)	Rich Results type
UrlInspectionResult.inspectionResultLink	api_schema_field	Inspection Result Link	UrlInspectionResult.inspectionResultLink (string)	Link to Search Console URL inspection.
UrlInspectionResult.ampResult	api_schema_field	Amp Result	UrlInspectionResult.ampResult (object)	Result of the AMP analysis. Absent if the page is not an AMP page.
UrlInspectionResult.ampResult.robotsTxtState	api_schema_field	Robots Txt State	AmpInspectionResult.robotsTxtState (string)	Whether or not the page is blocked to Google by a robots.txt rule.
UrlInspectionResult.ampResult.verdict	api_schema_field	Verdict	AmpInspectionResult.verdict (string)	The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results.
UrlInspectionResult.ampResult.indexingState	api_schema_field	Indexing State	AmpInspectionResult.indexingState (string)	Whether or not the page blocks indexing through a noindex rule.
UrlInspectionResult.ampResult.ampIndexStatusVerdict	api_schema_field	Amp Index Status Verdict	AmpInspectionResult.ampIndexStatusVerdict (string)	Index status of the AMP URL.
UrlInspectionResult.ampResult.pageFetchState	api_schema_field	Page Fetch State	AmpInspectionResult.pageFetchState (string)	Whether or not Google could fetch the AMP.
UrlInspectionResult.ampResult.ampUrl	api_schema_field	Amp Url	AmpInspectionResult.ampUrl (string)	URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected.
UrlInspectionResult.ampResult.lastCrawlTime	api_schema_field	Last Crawl Time	AmpInspectionResult.lastCrawlTime (string)	Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully.
UrlInspectionResult.ampResult.issues	api_schema_field	Issues	AmpInspectionResult.issues (array)	A list of zero or more AMP issues found for the inspected URL.
UrlInspectionResult.ampResult.issues.severity	api_schema_field	Severity	AmpIssue.severity (string)	Severity of this issue: WARNING or ERROR.
UrlInspectionResult.ampResult.issues.issueMessage	api_schema_field	Issue Message	AmpIssue.issueMessage (string)	Brief description of this issue.
UrlInspectionResult.mobileUsabilityResult	api_schema_field	Mobile Usability Result	UrlInspectionResult.mobileUsabilityResult (object)	Result of the Mobile usability analysis.
UrlInspectionResult.mobileUsabilityResult.verdict	api_schema_field	Verdict	MobileUsabilityInspectionResult.verdict (string)	High-level mobile-usability inspection result for this URL.
UrlInspectionResult.mobileUsabilityResult.issues	api_schema_field	Issues	MobileUsabilityInspectionResult.issues (array)	A list of zero or more mobile-usability issues detected for this URL.
UrlInspectionResult.mobileUsabilityResult.issues.issueType	api_schema_field	Issue Type	MobileUsabilityIssue.issueType (string)	Mobile-usability issue type.
UrlInspectionResult.mobileUsabilityResult.issues.message	api_schema_field	Message	MobileUsabilityIssue.message (string)	Additional information regarding the issue.
UrlInspectionResult.mobileUsabilityResult.issues.severity	api_schema_field	Severity	MobileUsabilityIssue.severity (string)	Not returned; reserved for future use.
IndexStatusInspectionResult.googleCanonical	api_schema_field	Google Canonical	IndexStatusInspectionResult.googleCanonical (string)	The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.
IndexStatusInspectionResult.indexingState	api_schema_field	Indexing State	IndexStatusInspectionResult.indexingState (string)	Whether or not the page blocks indexing through a noindex rule.
IndexStatusInspectionResult.userCanonical	api_schema_field	User Canonical	IndexStatusInspectionResult.userCanonical (string)	The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.
IndexStatusInspectionResult.referringUrls	api_schema_field	Referring Urls	IndexStatusInspectionResult.referringUrls (array)	URLs that link to the inspected URL, directly and indirectly.
IndexStatusInspectionResult.crawledAs	api_schema_field	Crawled As	IndexStatusInspectionResult.crawledAs (string)	Primary crawler that was used by Google to crawl your site.
IndexStatusInspectionResult.lastCrawlTime	api_schema_field	Last Crawl Time	IndexStatusInspectionResult.lastCrawlTime (string)	Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.
IndexStatusInspectionResult.verdict	api_schema_field	Verdict	IndexStatusInspectionResult.verdict (string)	High level verdict about whether the URL is indexed (indexed status), or can be indexed (live inspection).
IndexStatusInspectionResult.pageFetchState	api_schema_field	Page Fetch State	IndexStatusInspectionResult.pageFetchState (string)	Whether or not Google could retrieve the page from your server. Equivalent to ["page fetch"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.
IndexStatusInspectionResult.sitemap	api_schema_field	Sitemap	IndexStatusInspectionResult.sitemap (array)	Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.
IndexStatusInspectionResult.robotsTxtState	api_schema_field	Robots Txt State	IndexStatusInspectionResult.robotsTxtState (string)	Whether or not the page is blocked to Google by a robots.txt rule.
IndexStatusInspectionResult.coverageState	api_schema_field	Coverage State	IndexStatusInspectionResult.coverageState (string)	Could Google find and index the page. More details about page indexing appear in 'indexing_state'.
MobileUsabilityInspectionResult.verdict	api_schema_field	Verdict	MobileUsabilityInspectionResult.verdict (string)	High-level mobile-usability inspection result for this URL.
MobileUsabilityInspectionResult.issues	api_schema_field	Issues	MobileUsabilityInspectionResult.issues (array)	A list of zero or more mobile-usability issues detected for this URL.
MobileUsabilityInspectionResult.issues.issueType	api_schema_field	Issue Type	MobileUsabilityIssue.issueType (string)	Mobile-usability issue type.
MobileUsabilityInspectionResult.issues.message	api_schema_field	Message	MobileUsabilityIssue.message (string)	Additional information regarding the issue.
MobileUsabilityInspectionResult.issues.severity	api_schema_field	Severity	MobileUsabilityIssue.severity (string)	Not returned; reserved for future use.
RichResultsInspectionResult.verdict	api_schema_field	Verdict	RichResultsInspectionResult.verdict (string)	High-level rich results inspection result for this URL.
RichResultsInspectionResult.detectedItems	api_schema_field	Detected Items	RichResultsInspectionResult.detectedItems (array)	A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.
RichResultsInspectionResult.detectedItems.items	api_schema_field	Items	DetectedItems.items (array)	List of Rich Results items.
RichResultsInspectionResult.detectedItems.items.issues	api_schema_field	Issues	Item.issues (array)	A list of zero or more rich result issues found for this instance.
RichResultsInspectionResult.detectedItems.items.issues.severity	api_schema_field	Severity	RichResultsIssue.severity (string)	Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results.
RichResultsInspectionResult.detectedItems.items.issues.issueMessage	api_schema_field	Issue Message	RichResultsIssue.issueMessage (string)	Rich Results issue type.
RichResultsInspectionResult.detectedItems.items.name	api_schema_field	Name	Item.name (string)	The user-provided name of this item.
RichResultsInspectionResult.detectedItems.richResultType	api_schema_field	Rich Result Type	DetectedItems.richResultType (string)	Rich Results type

Microsoft Clarity

分析・SEO / API token

提供中

Clarityのサイト行動指標、ページ別指標、クリック・スクロール系指標を読み取ります。

MCPツール

ツール	引数	戻り値	説明
microsoft_clarity_live_insights	num_of_days	sessions / pages / metrics	Clarityの主要行動指標を取得する
microsoft_clarity_top_pages	num_of_days, limit	page / metrics	ページ別の行動指標を取得する

フィールド

ID	型	表示名	媒体側API名	説明
browser	official_dimension	Browser	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
device	official_dimension	Device	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
country_region	official_dimension	Country/Region	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
os	official_dimension	OS	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
source	official_dimension	Source	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
medium	official_dimension	Medium	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
campaign	official_dimension	Campaign	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
channel	official_dimension	Channel	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
url	official_dimension	URL	Clarity Data Export API dimension	Data Export APIのdimension1〜dimension3に指定できる公式dimensionです。
scroll_depth	official_metric	Scroll Depth	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
engagement_time	official_metric	Engagement Time	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
traffic	official_metric	Traffic	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
popular_pages	official_metric	Popular Pages	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
page_title	official_metric	Page Title	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
referrer_url	official_metric	Referrer URL	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
dead_click_count	official_metric	Dead Click Count	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
excessive_scroll	official_metric	Excessive Scroll	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
rage_click_count	official_metric	Rage Click Count	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
quickback_click	official_metric	Quickback Click	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
script_error_count	official_metric	Script Error Count	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
error_click_count	official_metric	Error Click Count	Clarity Data Export API metric	Data Export APIが返すClarityダッシュボード指標です。
numOfDays	request_or_response_field	対象日数	Clarity Data Export API	直近24/48/72時間に相当する1〜3日の取得期間です。
dimension1	request_or_response_field	第1分解軸	Clarity Data Export API	最初のdimension指定です。
dimension2	request_or_response_field	第2分解軸	Clarity Data Export API	2つ目のdimension指定です。
dimension3	request_or_response_field	第3分解軸	Clarity Data Export API	3つ目のdimension指定です。
metricName	request_or_response_field	指標名	Clarity Data Export API	レスポンス内の指標名です。
information	request_or_response_field	指標行配列	Clarity Data Export API	metricNameごとの行データ配列です。
totalSessionCount	request_or_response_field	合計セッション数	Clarity Data Export API	サンプルレスポンスに含まれる合計セッション数です。
totalBotSessionCount	request_or_response_field	Botセッション数	Clarity Data Export API	サンプルレスポンスに含まれるBotセッション数です。
distantUserCount	request_or_response_field	ユーザー数	Clarity Data Export API	サンプルレスポンスに含まれるユーザー数です。
PagesPerSessionPercentage	request_or_response_field	セッションあたりページ	Clarity Data Export API	サンプルレスポンスに含まれるページ/セッション指標です。

Google広告

広告 / Google OAuth

提供中

広告費、表示回数、クリック、CV、CV値、CTR、平均CPC、キャンペーン、キーワード、検索語句を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_google_ads_accounts	なし	customer_id / name / currency	接続済み広告アカウントを一覧化する
google_ads_performance_summary	start_date, end_date, customer_id	cost / clicks / impressions / conversions / conversions_value	アカウント全体の日次実績を取得する
run_google_ads_report	report_type, start_date, end_date, customer_id, limit	rows / ctr / average_cpc	キャンペーン・キーワード・検索語句別に取得する

フィールド

ID	型	表示名	媒体側API名	説明
metrics.absolute_top_impression_percentage	official_metric	Absolute top impression percentage	Google Ads API v24 metrics	Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
metrics.active_view_audibility_invalid_givt_measurable_impressions_rate	official_metric	Active view audibility invalid givt measurable impressions rate	Google Ads API v24 metrics	The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility. Only includes GIVT (general invalid traffic) impressions.
metrics.active_view_audibility_invalid_measurable_impressions_rate	official_metric	Active view audibility invalid measurable impressions rate	Google Ads API v24 metrics	The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility.
metrics.active_view_audibility_measurable_impressions	official_metric	Active view audibility measurable impressions	Google Ads API v24 metrics	The number of impressions for which Active View could measure if the ad was audible.
metrics.active_view_audibility_measurable_impressions_rate	official_metric	Active view audibility measurable impressions rate	Google Ads API v24 metrics	The number of impressions for which Active View could measure if the ad was audible, divided by the total number of impressions with Active View audio enabled.
metrics.active_view_audible_impressions	official_metric	Active view audible impressions	Google Ads API v24 metrics	The number of impressions that were audible (volume > 0%) at any point during the ad playback.
metrics.active_view_audible_impressions_rate	official_metric	Active view audible impressions rate	Google Ads API v24 metrics	The number of impressions that were audible (volume > 0%) at any point during the ad playback, divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_quartile_p100_rate	official_metric	Active view audible quartile p100 rate	Google Ads API v24 metrics	The number of impressions that were audible at the fourth quartile of the ad playback, divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_quartile_p25_rate	official_metric	Active view audible quartile p25 rate	Google Ads API v24 metrics	The number of impressions that were audible at the first quartile of the ad playback, divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_quartile_p50_rate	official_metric	Active view audible quartile p50 rate	Google Ads API v24 metrics	The number of impressions that were audible at the second quartile of the ad playback, divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_quartile_p75_rate	official_metric	Active view audible quartile p75 rate	Google Ads API v24 metrics	The number of impressions that were audible at the third quartile of the ad playback, divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_thirty_seconds_impressions	official_metric	Active view audible thirty seconds impressions	Google Ads API v24 metrics	The number of impressions that were audible for at least 30 seconds (cumulative).
metrics.active_view_audible_thirty_seconds_impressions_rate	official_metric	Active view audible thirty seconds impressions rate	Google Ads API v24 metrics	The number of impressions that were audible for at least 30 seconds (cumulative), divided by the total number of impressions measurable for audibility.
metrics.active_view_audible_two_seconds_impressions	official_metric	Active view audible two seconds impressions	Google Ads API v24 metrics	The number of impressions that were audible for at least 2 seconds (cumulative).
metrics.active_view_audible_two_seconds_impressions_rate	official_metric	Active view audible two seconds impressions rate	Google Ads API v24 metrics	The number of impressions that were audible for at least 2 seconds (cumulative), divided by the total number of impressions measurable for audibility.
metrics.active_view_cpm	official_metric	Active view cpm	Google Ads API v24 metrics	Average cost of viewable impressions ( active_view_impressions ).
metrics.active_view_ctr	official_metric	Active view ctr	Google Ads API v24 metrics	Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
metrics.active_view_impressions	official_metric	Active view impressions	Google Ads API v24 metrics	A measurement of how often your ad has become viewable on a Display Network site.
metrics.active_view_measurability	official_metric	Active view measurability	Google Ads API v24 metrics	The ratio of impressions that could be measured by Active View over the number of served impressions.
metrics.active_view_measurable_cost_micros	official_metric	Active view measurable cost micros	Google Ads API v24 metrics	The cost of the impressions you received that were measurable by Active View.
metrics.active_view_measurable_impressions	official_metric	Active view measurable impressions	Google Ads API v24 metrics	The number of times your ads are appearing on placements in positions where they can be seen.
metrics.active_view_viewability	official_metric	Active view viewability	Google Ads API v24 metrics	The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
metrics.all_average_cart_size	official_metric	All average cart size	Google Ads API v24 metrics	All average cart size is the average number of products in each order attributed to your ads. Includes the amount from the average_cart_size metric, plus avg. cart size from all your conversion actions, even if your campaigns are not actively optimizing towar…
metrics.all_average_order_value_micros	official_metric	All average order value micros	Google Ads API v24 metrics	All average order value is the average revenue you made per order attributed to your ads. Includes the amount from the average_order_value metric, plus avg. order value from all your conversion actions, even if your campaigns are not actively optimizing towar…
metrics.all_conversions	official_metric	All conversions	Google Ads API v24 metrics	The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
metrics.all_conversions_by_conversion_date	official_metric	All conversions by conversion date	Google Ads API v24 metrics	The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns ar…
metrics.all_conversions_from_click_to_call	official_metric	All conversions from click to call	Google Ads API v24 metrics	The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
metrics.all_conversions_from_directions	official_metric	All conversions from directions	Google Ads API v24 metrics	The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only.
metrics.all_conversions_from_interactions_rate	official_metric	All conversions from interactions rate	Google Ads API v24 metrics	All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
metrics.all_conversions_from_interactions_value_per_interaction	official_metric	All conversions from interactions value per interaction	Google Ads API v24 metrics	The value of all conversions from interactions divided by the total number of interactions.
metrics.all_conversions_from_location_asset_click_to_call	official_metric	All conversions from location asset click to call	Google Ads API v24 metrics	Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_directions	official_metric	All conversions from location asset directions	Google Ads API v24 metrics	Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_menu	official_metric	All conversions from location asset menu	Google Ads API v24 metrics	Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_order	official_metric	All conversions from location asset order	Google Ads API v24 metrics	Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_other_engagement	official_metric	All conversions from location asset other engagement	Google Ads API v24 metrics	Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_store_visits	official_metric	All conversions from location asset store visits	Google Ads API v24 metrics	Estimated number of visits to the business after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_location_asset_website	official_metric	All conversions from location asset website	Google Ads API v24 metrics	Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
metrics.all_conversions_from_menu	official_metric	All conversions from menu	Google Ads API v24 metrics	The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only.
metrics.all_conversions_from_order	official_metric	All conversions from order	Google Ads API v24 metrics	The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.
metrics.all_conversions_from_other_engagement	official_metric	All conversions from other engagement	Google Ads API v24 metrics	The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only.
metrics.all_conversions_from_store_visit	official_metric	All conversions from store visit	Google Ads API v24 metrics	Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.
metrics.all_conversions_from_store_website	official_metric	All conversions from store website	Google Ads API v24 metrics	The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.
metrics.all_conversions_value	official_metric	All conversions value	Google Ads API v24 metrics	The value of all conversions.
metrics.all_conversions_value_by_conversion_date	official_metric	All conversions value by conversion date	Google Ads API v24 metrics	The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns .
metrics.all_conversions_value_per_cost	official_metric	All conversions value per cost	Google Ads API v24 metrics	The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
metrics.all_cost_of_goods_sold_micros	official_metric	All cost of goods sold micros	Google Ads API v24 metrics	All cost of goods sold is the total cost of the products you sold in orders attributed to your ads. Includes the amount from the cost_of_goods_sold_micros metric, plus cost of goods sold from all conversion actions, even if your campaigns are not actively opt…
metrics.all_cross_sell_cost_of_goods_sold_micros	official_metric	All cross sell cost of goods sold micros	Google Ads API v24 metrics	All cross-sell cost of goods sold is the total cost of products sold as a result of advertising a different product. Includes the amount from the cross_sell_cost_of_goods_sold_micros metric, plus cross-sell cost of goods sold from all your conversion actions,…
metrics.all_cross_sell_gross_profit_micros	official_metric	All cross sell gross profit micros	Google Ads API v24 metrics	All cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). Includes the amount from the cross_sell_gross_profit_micros metric, plus cross-sell gross profit from all yo…
metrics.all_cross_sell_revenue_micros	official_metric	All cross sell revenue micros	Google Ads API v24 metrics	All cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. Includes the amount from the cross_sell_revenue_micros metric, plus cross-sell revenue from all your conversion actions, even if your campai…
metrics.all_cross_sell_units_sold	official_metric	All cross sell units sold	Google Ads API v24 metrics	All cross-sell units sold is the total number of products sold as a result of advertising a different product. Includes the amount shown in the cross_sell_units_sold metric, plus cross-sell units sold from all your conversion actions, even if your campaigns a…
metrics.all_gross_profit_margin	official_metric	All gross profit margin	Google Ads API v24 metrics	All gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). This value is between 0.0 and 1.0, where 1.0 means 100%. Includes the amount from the gross_profit_margin metri…
metrics.all_gross_profit_micros	official_metric	All gross profit micros	Google Ads API v24 metrics	All gross profit is the total profit made from orders attributed to your ads minus the cost of goods sold (COGS). Includes the amount from the gross_profit_micros metric, plus gross profit from all your conversion actions, even if your campaigns are not activ…
metrics.all_lead_cost_of_goods_sold_micros	official_metric	All lead cost of goods sold micros	Google Ads API v24 metrics	All lead cost of goods sold is the total cost of products sold as a result of advertising the same product. Includes the amount shown in the lead_cost_of_goods_sold_micros metric, plus lead cost of goods sold from all your conversion actions, even if your cam…
metrics.all_lead_gross_profit_micros	official_metric	All lead gross profit micros	Google Ads API v24 metrics	All lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). Includes the amount from the lead_gross_profit_micros metric, plus lead gross profit from all your conversion actions…
metrics.all_lead_revenue_micros	official_metric	All lead revenue micros	Google Ads API v24 metrics	All lead revenue is the total amount you made from products sold as a result of advertising the same product. Includes the amount shown in the lead_revenue_micros metric, plus lead revenue from all your conversion actions, even if your campaigns are not activ…
metrics.all_lead_units_sold	official_metric	All lead units sold	Google Ads API v24 metrics	All lead units sold is the total number of products sold as a result of advertising the same product. Includes the amount shown in the lead_units_sold metric, plus lead units sold from all your conversion actions, even if your campaigns are not actively optim…
metrics.all_new_customer_lifetime_value	official_metric	All new customer lifetime value	Google Ads API v24 metrics	All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If yo…
metrics.all_orders	official_metric	All orders	Google Ads API v24 metrics	All orders is total number of purchase conversions attributed to your ads. Includes the amount from the orders metric, plus orders from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product…
metrics.all_revenue_micros	official_metric	All revenue micros	Google Ads API v24 metrics	All revenue is the total you made from orders attributed to your ads. Includes the amount from the revenue_micros metric, plus revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using pro…
metrics.all_units_sold	official_metric	All units sold	Google Ads API v24 metrics	All units sold is the total number of products sold from orders attributed to your ads. Includes the amount from the units_sold metric, plus units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's cal…
metrics.all_value_adjustment	official_metric	All value adjustment	Google Ads API v24 metrics	The conversion value rule adjustment from all conversions in all conversion categories.
metrics.asset_pinned_as_description_position_one_count	official_metric	Asset pinned as description position one count	Google Ads API v24 metrics	Number of entities in which the asset is pinned to description 1. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.asset_pinned_as_description_position_two_count	official_metric	Asset pinned as description position two count	Google Ads API v24 metrics	Number of entities in which the asset is pinned to description 2. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.asset_pinned_as_headline_position_one_count	official_metric	Asset pinned as headline position one count	Google Ads API v24 metrics	Number of entities in which the asset is pinned to headline 1. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.asset_pinned_as_headline_position_three_count	official_metric	Asset pinned as headline position three count	Google Ads API v24 metrics	Number of entities in which the asset is pinned to headline 3. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.asset_pinned_as_headline_position_two_count	official_metric	Asset pinned as headline position two count	Google Ads API v24 metrics	Number of entities in which the asset is pinned to headline 2. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.asset_pinned_total_count	official_metric	Asset pinned total count	Google Ads API v24 metrics	Number of total usages in which the asset is pinned. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView . This metric is only supported in Search channel.
metrics.auction_insight_search_absolute_top_impression_percentage	official_metric	Auction insight search absolute top impression percentage	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells how often the ads of another participant showed in the most prominent position on the search results page. This percentage is computed only over the auctions that you appeared in the page. This met…
metrics.auction_insight_search_impression_share	official_metric	Auction insight search impression share	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not…
metrics.auction_insight_search_outranking_share	official_metric	Auction insight search outranking share	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below…
metrics.auction_insight_search_overlap_rate	official_metric	Auction insight search overlap rate	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available.
metrics.auction_insight_search_position_above_rate	official_metric	Auction insight search position above rate	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available.
metrics.auction_insight_search_top_impression_percentage	official_metric	Auction insight search top impression percentage	Google Ads API v24 metrics	This metric is part of the Auction Insights report, and tells how often the ads of another participant showed adjacent to the top organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publ…
metrics.average_cart_size	official_metric	Average cart size	Google Ads API v24 metrics	Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total…
metrics.average_cost	official_metric	Average cost	Google Ads API v24 metrics	The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
metrics.average_cpc	official_metric	Average cpc	Google Ads API v24 metrics	The total cost of all clicks divided by the total number of clicks received.
metrics.average_cpe	official_metric	Average cpe	Google Ads API v24 metrics	The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
metrics.average_cpm	official_metric	Average cpm	Google Ads API v24 metrics	Average cost-per-thousand impressions (CPM).
metrics.average_impression_frequency_per_user	official_metric	Average impression frequency per user	Google Ads API v24 metrics	The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Dis…
metrics.average_order_value_micros	official_metric	Average order value micros	Google Ads API v24 metrics	Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total n…
metrics.average_page_views	official_metric	Average page views	Google Ads API v24 metrics	Average number of pages viewed per session.
metrics.average_target_cpa_micros	official_metric	Average target cpa micros	Google Ads API v24 metrics	The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
metrics.average_target_roas	official_metric	Average target roas	Google Ads API v24 metrics	The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
metrics.average_time_on_site	official_metric	Average time on site	Google Ads API v24 metrics	Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
metrics.average_video_watch_time_duration_millis	official_metric	Average video watch time duration millis	Google Ads API v24 metrics	Average video watch time duration in milliseconds for video impressions that started playing.
metrics.benchmark_average_max_cpc	official_metric	Benchmark average max cpc	Google Ads API v24 metrics	An indication of how other advertisers are bidding on similar products.
metrics.benchmark_ctr	official_metric	Benchmark ctr	Google Ads API v24 metrics	An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.
metrics.biddable_app_install_conversions	official_metric	Biddable app install conversions	Google Ads API v24 metrics	Number of app installs.
metrics.biddable_app_post_install_conversions	official_metric	Biddable app post install conversions	Google Ads API v24 metrics	Number of in-app actions.
metrics.biddable_cohort_app_post_install_conversions	official_metric	Biddable cohort app post install conversions	Google Ads API v24 metrics	Participated in-app actions. The number of in app actions that come directly or indirectly from the campaign.
metrics.biddable_indirect_install_first_in_app_conversion_micros	official_metric	Biddable indirect install first in app conversion micros	Google Ads API v24 metrics	The number of biddable first in app conversions where the app install was driven by interaction with a web campaign.
metrics.bounce_rate	official_metric	Bounce rate	Google Ads API v24 metrics	Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
metrics.clicks	official_metric	Clicks	Google Ads API v24 metrics	The number of clicks.
metrics.clicks_margin_of_error	official_metric	Clicks margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on clicks. Together with clicks_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment…
metrics.clicks_p_value	official_metric	Clicks p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on clicks. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on clicks, is 3%.
metrics.clicks_point_estimate	official_metric	Clicks point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on clicks. Together with clicks_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment…
metrics.clicks_unique_query_clusters	official_metric	Clicks unique query clusters	Google Ads API v24 metrics	Unique query intent cluster count for clicks.
metrics.combined_clicks	official_metric	Combined clicks	Google Ads API v24 metrics	The number of times your ad or your site's listing in the unpaid results was clicked. See About measuring paid and organic search results .
metrics.combined_clicks_per_query	official_metric	Combined clicks per query	Google Ads API v24 metrics	The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See About measuring paid and organic search results for details.
metrics.combined_queries	official_metric	Combined queries	Google Ads API v24 metrics	The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See About measuring paid and organic search results for details.
metrics.content_budget_lost_impression_share	official_metric	Content budget lost impression share	Google Ads API v24 metrics	The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.content_impression_share	official_metric	Content impression share	Google Ads API v24 metrics	The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
metrics.content_rank_lost_impression_share	official_metric	Content rank lost impression share	Google Ads API v24 metrics	The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.control_clicks	official_metric	Control clicks	Google Ads API v24 metrics	The number of clicks on the control arm of an experiment. The treatment clicks value can be selected by using clicks .
metrics.control_conversion_value	official_metric	Control conversion value	Google Ads API v24 metrics	The conversion value metric on the control arm of the experiment. The treatment conversion value can be selected by using conversions_value .
metrics.control_conversion_value_per_cost	official_metric	Control conversion value per cost	Google Ads API v24 metrics	The conversion value per cost metric on the control arm of the experiment. The treatment conversion value per cost value can be selected by using conversions_value_per_cost .
metrics.control_conversions	official_metric	Control conversions	Google Ads API v24 metrics	The conversions metric on the control arm of the experiment. The treatment conversions value can be selected by using conversions .
metrics.control_cost_micros	official_metric	Control cost micros	Google Ads API v24 metrics	The cost metric on the control arm of the experiment. The treatment cost value can be selected by using cost_micros .
metrics.control_cost_per_conversion	official_metric	Control cost per conversion	Google Ads API v24 metrics	The cost per conversion metric on the control arm of the experiment. The treatment cost per conversion value can be selected by using cost_per_conversion .
metrics.control_impressions	official_metric	Control impressions	Google Ads API v24 metrics	The impressions metric on the control arm of the experiment. The treatment impressions value can be selected by using impressions .
metrics.conversion_last_conversion_date	official_metric	Conversion last conversion date	Google Ads API v24 metrics	The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
metrics.conversion_last_received_request_date_time	official_metric	Conversion last received request date time	Google Ads API v24 metrics	The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not prev…
metrics.conversion_value_change_point_estimate	official_metric	Conversion value change point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on conversion value change. Together with conversion_value_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity bei…
metrics.conversion_value_margin_of_error	official_metric	Conversion value margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on conversion value. Together with conversion_value_change_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity bei…
metrics.conversion_value_p_value	official_metric	Conversion value p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on conversion value. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value, is 3%.
metrics.conversion_value_per_cost_change_point_estimate	official_metric	Conversion value per cost change point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on conversion value per cost change. Together with conversion_value_per_cost_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated…
metrics.conversion_value_per_cost_margin_of_error	official_metric	Conversion value per cost margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on conversion value per cost. Together with conversion_value_per_cost_change_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated…
metrics.conversion_value_per_cost_p_value	official_metric	Conversion value per cost p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on conversion value per cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value per cost,…
metrics.conversions	official_metric	Conversions	Google Ads API v24 metrics	The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.conversions_absolute_change_margin_of_error	official_metric	Conversions absolute change margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on conversions absolute change. Together with conversions_absolute_change_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. T…
metrics.conversions_absolute_change_p_value	official_metric	Conversions absolute change p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on conversions absolute change. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversions absolute cha…
metrics.conversions_absolute_change_point_estimate	official_metric	Conversions absolute change point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on conversions absolute change. Together with conversions_absolute_change_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. T…
metrics.conversions_by_conversion_date	official_metric	Conversions by conversion date	Google Ads API v24 metrics	The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date…
metrics.conversions_from_interactions_rate	official_metric	Conversions from interactions rate	Google Ads API v24 metrics	Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based biddi…
metrics.conversions_from_interactions_value_per_interaction	official_metric	Conversions from interactions value per interaction	Google Ads API v24 metrics	The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize fo…
metrics.conversions_unique_query_clusters	official_metric	Conversions unique query clusters	Google Ads API v24 metrics	Unique query intent cluster count for conversions.
metrics.conversions_value	official_metric	Conversions value	Google Ads API v24 metrics	The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.conversions_value_by_conversion_date	official_metric	Conversions value by conversion date	Google Ads API v24 metrics	The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date…
metrics.conversions_value_per_cost	official_metric	Conversions value per cost	Google Ads API v24 metrics	The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.cost_converted_currency_per_platform_comparable_conversion	official_metric	Cost converted currency per platform comparable conversion	Google Ads API v24 metrics	The cost of the platform comparable conversion in the currency of the authorized customer.
metrics.cost_micros	official_metric	Cost micros	Google Ads API v24 metrics	The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
metrics.cost_micros_change_point_estimate	official_metric	Cost micros change point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on cost change. Together with cost_micros_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (…
metrics.cost_micros_margin_of_error	official_metric	Cost micros margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on cost. Together with cost_micros_change_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (…
metrics.cost_micros_p_value	official_metric	Cost micros p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost, is 3%.
metrics.cost_of_goods_sold_micros	official_metric	Cost of goods sold micros	Google Ads API v24 metrics	Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold ar…
metrics.cost_per_all_conversions	official_metric	Cost per all conversions	Google Ads API v24 metrics	The cost of ad interactions divided by all conversions.
metrics.cost_per_conversion	official_metric	Cost per conversion	Google Ads API v24 metrics	The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.cost_per_conversion_change_point_estimate	official_metric	Cost per conversion change point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on cost per conversion change. Together with cost_per_conversion_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quanti…
metrics.cost_per_conversion_margin_of_error	official_metric	Cost per conversion margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on cost per conversion. Together with cost_per_conversion_change_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quanti…
metrics.cost_per_conversion_p_value	official_metric	Cost per conversion p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on cost per conversion. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost per conversion, is 3%.
metrics.cost_per_current_model_attributed_conversion	official_metric	Cost per current model attributed conversion	Google Ads API v24 metrics	The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these…
metrics.cost_per_platform_comparable_conversion	official_metric	Cost per platform comparable conversion	Google Ads API v24 metrics	The cost of ad interactions divided by the number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimiz…
metrics.coviewed_impressions	official_metric	Coviewed impressions	Google Ads API v24 metrics	All co-viewed impressions represent the total number of people who saw your ad. This includes people who are signed into their Google Account, as well as other people who are watching the same ad on a connected TV. This metric is only available for the Campai…
metrics.cross_device_conversions	official_metric	Cross device conversions	Google Ads API v24 metrics	Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions .
metrics.cross_device_conversions_by_conversion_date	official_metric	Cross device conversions by conversion date	Google Ads API v24 metrics	The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns
metrics.cross_device_conversions_value	official_metric	Cross device conversions value	Google Ads API v24 metrics	The sum of the value of cross-device conversions.
metrics.cross_device_conversions_value_by_conversion_date	official_metric	Cross device conversions value by conversion date	Google Ads API v24 metrics	The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns
metrics.cross_device_conversions_value_micros	official_metric	Cross device conversions value micros	Google Ads API v24 metrics	The sum of the value of cross-device conversions, in micros.
metrics.cross_sell_cost_of_goods_sold_micros	official_metric	Cross sell cost of goods sold micros	Google Ads API v24 metrics	Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the…
metrics.cross_sell_gross_profit_micros	official_metric	Cross sell gross profit micros	Google Ads API v24 metrics	Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was…
metrics.cross_sell_revenue_micros	official_metric	Cross sell revenue micros	Google Ads API v24 metrics	Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purch…
metrics.cross_sell_units_sold	official_metric	Cross sell units sold	Google Ads API v24 metrics	Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has…
metrics.ctr	official_metric	Ctr	Google Ads API v24 metrics	The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
metrics.current_model_attributed_conversions	official_metric	Current model attributed conversions	Google Ads API v24 metrics	Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strate…
metrics.current_model_attributed_conversions_from_interactions_rate	official_metric	Current model attributed conversions from interactions rate	Google Ads API v24 metrics	Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you us…
metrics.current_model_attributed_conversions_from_interactions_value_per_interaction	official_metric	Current model attributed conversions from interactions value per interaction	Google Ads API v24 metrics	The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid str…
metrics.current_model_attributed_conversions_value	official_metric	Current model attributed conversions value	Google Ads API v24 metrics	The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.current_model_attributed_conversions_value_per_cost	official_metric	Current model attributed conversions value per cost	Google Ads API v24 metrics	The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimiz…
metrics.eligible_impressions_from_location_asset_store_reach	official_metric	Eligible impressions from location asset store reach	Google Ads API v24 metrics	Number of impressions in which the business location was shown or the location was used for targeting. This measure is coming from Asset based location.
metrics.engagement_rate	official_metric	Engagement rate	Google Ads API v24 metrics	How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
metrics.engagements	official_metric	Engagements	Google Ads API v24 metrics	The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
metrics.general_invalid_click_rate	official_metric	General invalid click rate	Google Ads API v24 metrics	The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (tha…
metrics.general_invalid_clicks	official_metric	General invalid clicks	Google Ads API v24 metrics	Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for…
metrics.gmail_forwards	official_metric	Gmail forwards	Google Ads API v24 metrics	The number of times the ad was forwarded to someone else as a message.
metrics.gmail_saves	official_metric	Gmail saves	Google Ads API v24 metrics	The number of times someone has saved your Gmail ad to their inbox as a message.
metrics.gmail_secondary_clicks	official_metric	Gmail secondary clicks	Google Ads API v24 metrics	The number of clicks to the landing page on the expanded state of Gmail ads.
metrics.gross_profit_margin	official_metric	Gross profit margin	Google Ads API v24 metrics	Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is…
metrics.gross_profit_micros	official_metric	Gross profit micros	Google Ads API v24 metrics	Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include p…
metrics.historical_creative_quality_score	official_metric	Historical creative quality score	Google Ads API v24 metrics	The creative historical quality score.
metrics.historical_landing_page_quality_score	official_metric	Historical landing page quality score	Google Ads API v24 metrics	The quality of historical landing page experience.
metrics.historical_quality_score	official_metric	Historical quality score	Google Ads API v24 metrics	The historical quality score.
metrics.historical_search_predicted_ctr	official_metric	Historical search predicted ctr	Google Ads API v24 metrics	The historical search predicted click through rate (CTR).
metrics.hotel_average_lead_value_micros	official_metric	Hotel average lead value micros	Google Ads API v24 metrics	Average lead value based on clicks.
metrics.hotel_commission_rate_micros	official_metric	Hotel commission rate micros	Google Ads API v24 metrics	Commission bid rate in micros. A 20% commission is represented as 200,000.
metrics.hotel_eligible_impressions	official_metric	Hotel eligible impressions	Google Ads API v24 metrics	The number of impressions that hotel partners could have had given their feed performance.
metrics.hotel_expected_commission_cost	official_metric	Hotel expected commission cost	Google Ads API v24 metrics	Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
metrics.hotel_price_difference_percentage	official_metric	Hotel price difference percentage	Google Ads API v24 metrics	The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
metrics.impressions	official_metric	Impressions	Google Ads API v24 metrics	Count of how often your ad has appeared on a search results page or website on the Google Network.
metrics.impressions_from_store_reach	official_metric	Impressions from store reach	Google Ads API v24 metrics	The number of times a business's location-based ad was shown. This metric applies to feed items only.
metrics.impressions_margin_of_error	official_metric	Impressions margin of error	Google Ads API v24 metrics	The margin of error when estimating the experiment's effect on impressions. Together with impressions_point_estimate , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (…
metrics.impressions_p_value	official_metric	Impressions p value	Google Ads API v24 metrics	The p-value for the null hypothesis that the experiment has no effect on impressions. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on impressions, is 3%.
metrics.impressions_point_estimate	official_metric	Impressions point estimate	Google Ads API v24 metrics	The point estimate when estimating the experiment's effect on impressions. Together with impressions_margin_of_error , they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (…
metrics.impressions_unique_query_clusters	official_metric	Impressions unique query clusters	Google Ads API v24 metrics	Unique query intent cluster count for impressions.
metrics.interaction_event_types	official_metric	Interaction event types	Google Ads API v24 metrics	The types of payable and free interactions.
metrics.interaction_rate	official_metric	Interaction rate	Google Ads API v24 metrics	How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
metrics.interactions	official_metric	Interactions	Google Ads API v24 metrics	The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
metrics.invalid_click_rate	official_metric	Invalid click rate	Google Ads API v24 metrics	The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
metrics.invalid_clicks	official_metric	Invalid clicks	Google Ads API v24 metrics	Number of clicks Google considers illegitimate and doesn't charge you for.
metrics.lead_cost_of_goods_sold_micros	official_metric	Lead cost of goods sold micros	Google Ads API v24 metrics	Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated pr…
metrics.lead_gross_profit_micros	official_metric	Lead gross profit micros	Google Ads API v24 metrics	Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacte…
metrics.lead_revenue_micros	official_metric	Lead revenue micros	Google Ads API v24 metrics	Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has a…
metrics.lead_units_sold	official_metric	Lead units sold	Google Ads API v24 metrics	Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associ…
metrics.linked_entities_count	official_metric	Linked entities count	Google Ads API v24 metrics	Number of linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView .
metrics.linked_sample_entities	official_metric	Linked sample entities	Google Ads API v24 metrics	A list of up to 20 sample linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView .
metrics.message_chat_rate	official_metric	Message chat rate	Google Ads API v24 metrics	Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate…
metrics.message_chats	official_metric	Message chats	Google Ads API v24 metrics	Number of message chats initiated for Click To Message impressions that were message tracking eligible.
metrics.message_impressions	official_metric	Message impressions	Google Ads API v24 metrics	Number of Click To Message impressions that were message tracking eligible.
metrics.mobile_friendly_clicks_percentage	official_metric	Mobile friendly clicks percentage	Google Ads API v24 metrics	The percentage of mobile clicks that go to a mobile-friendly page.
metrics.new_customer_lifetime_value	official_metric	New customer lifetime value	Google Ads API v24 metrics	New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the c…
metrics.optimization_score_uplift	official_metric	Optimization score uplift	Google Ads API v24 metrics	Total optimization score uplift of all recommendations.
metrics.optimization_score_url	official_metric	Optimization score url	Google Ads API v24 metrics	URL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign , and can be segmented by segments.recommendation_type . For example, SELECT metrics.optimization_score_url, segments.recommendation_typ…
metrics.orders	official_metric	Orders	Google Ads API v24 metrics	Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks f…
metrics.organic_clicks	official_metric	Organic clicks	Google Ads API v24 metrics	The number of times someone clicked your site's listing in the unpaid results for a particular query. See About measuring paid and organic search results .
metrics.organic_clicks_per_query	official_metric	Organic clicks per query	Google Ads API v24 metrics	The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See About measuring paid and organic search results .
metrics.organic_impressions	official_metric	Organic impressions	Google Ads API v24 metrics	The number of listings for your site in the unpaid search results. See About measuring paid and organic search results .
metrics.organic_impressions_per_query	official_metric	Organic impressions per query	Google Ads API v24 metrics	The number of times a page from your site was listed in the unpaid search results ( organic_impressions ) divided by the number of searches returning your site's listing in the unpaid results ( organic_queries ). See About measuring paid and organic search re…
metrics.organic_queries	official_metric	Organic queries	Google Ads API v24 metrics	The total number of searches that returned your site's listing in the unpaid results. See About measuring paid and organic search results for details.
metrics.percent_new_visitors	official_metric	Percent new visitors	Google Ads API v24 metrics	Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
metrics.phone_calls	official_metric	Phone calls	Google Ads API v24 metrics	Number of offline phone calls.
metrics.phone_impressions	official_metric	Phone impressions	Google Ads API v24 metrics	Number of offline phone impressions.
metrics.phone_through_rate	official_metric	Phone through rate	Google Ads API v24 metrics	Number of phone calls received ( phone_calls ) divided by the number of times your phone number is shown ( phone_impressions ).
metrics.platform_comparable_conversions	official_metric	Platform comparable conversions	Google Ads API v24 metrics	The number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.platform_comparable_conversions_by_conversion_date	official_metric	Platform comparable conversions by conversion date	Google Ads API v24 metrics	The number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you…
metrics.platform_comparable_conversions_from_interactions_rate	official_metric	Platform comparable conversions from interactions rate	Google Ads API v24 metrics	Platform comparable conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use…
metrics.platform_comparable_conversions_from_interactions_value_per_interaction	official_metric	Platform comparable conversions from interactions value per interaction	Google Ads API v24 metrics	The value of platform comparable conversions from interactions divided by the number of ad interactions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid stra…
metrics.platform_comparable_conversions_value	official_metric	Platform comparable conversions value	Google Ads API v24 metrics	The value of platform comparable conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
metrics.platform_comparable_conversions_value_by_conversion_date	official_metric	Platform comparable conversions value by conversion date	Google Ads API v24 metrics	The value of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you u…
metrics.platform_comparable_conversions_value_per_cost	official_metric	Platform comparable conversions value per cost	Google Ads API v24 metrics	The value of conversions divided by the cost of ad interactions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversio…
metrics.primary_impressions	official_metric	Primary impressions	Google Ads API v24 metrics	Primary impression is counted each time your ad is served. This metric is only available for the Campaign resource with adjusted_age_range and adjusted_gender segments. These segmentations are mandatory to get the primary impressions.
metrics.publisher_organic_clicks	official_metric	Publisher organic clicks	Google Ads API v24 metrics	Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
metrics.publisher_purchased_clicks	official_metric	Publisher purchased clicks	Google Ads API v24 metrics	Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
metrics.publisher_unknown_clicks	official_metric	Publisher unknown clicks	Google Ads API v24 metrics	Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"
metrics.relative_ctr	official_metric	Relative ctr	Google Ads API v24 metrics	Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
metrics.results_conversions_purchase	official_metric	Results conversions purchase	Google Ads API v24 metrics	The purchase conversion stats for the unified goals results.
metrics.revenue_micros	official_metric	Revenue micros	Google Ads API v24 metrics	Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any d…
metrics.search_absolute_top_impression_share	official_metric	Search absolute top impression share	Google Ads API v24 metrics	The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See About top and absolute top metrics for details. Any value below 0.1 is reported as 0.0999.
metrics.search_budget_lost_absolute_top_impression_share	official_metric	Search budget lost absolute top impression share	Google Ads API v24 metrics	The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.900…
metrics.search_budget_lost_impression_share	official_metric	Search budget lost impression share	Google Ads API v24 metrics	The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.search_budget_lost_top_impression_share	official_metric	Search budget lost top impression share	Google Ads API v24 metrics	The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.search_click_share	official_metric	Search click share	Google Ads API v24 metrics	The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
metrics.search_exact_match_impression_share	official_metric	Search exact match impression share	Google Ads API v24 metrics	The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match ty…
metrics.search_impression_share	official_metric	Search impression share	Google Ads API v24 metrics	The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
metrics.search_rank_lost_absolute_top_impression_share	official_metric	Search rank lost absolute top impression share	Google Ads API v24 metrics	The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.search_rank_lost_impression_share	official_metric	Search rank lost impression share	Google Ads API v24 metrics	The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.search_rank_lost_top_impression_share	official_metric	Search rank lost top impression share	Google Ads API v24 metrics	The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
metrics.search_top_impression_share	official_metric	Search top impression share	Google Ads API v24 metrics	The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999…
metrics.search_volume	official_metric	Search volume	Google Ads API v24 metrics	Search volume range for a search term insight category.
metrics.sk_ad_network_installs	official_metric	Sk ad network installs	Google Ads API v24 metrics	The number of iOS Store Kit Ad Network conversions.
metrics.sk_ad_network_total_conversions	official_metric	Sk ad network total conversions	Google Ads API v24 metrics	The total number of iOS Store Kit Ad Network conversions.
metrics.speed_score	official_metric	Speed score	Google Ads API v24 metrics	A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest.
metrics.store_visits_last_click_model_attributed_conversions	official_metric	Store visits last click model attributed conversions	Google Ads API v24 metrics	The amount of business visits attributed by the last click model.
metrics.svr	official_metric	Svr	Google Ads API v24 metrics	This feature is available to allowlisted accounts only.
metrics.top_impression_percentage	official_metric	Top impression percentage	Google Ads API v24 metrics	The percent of your ad impressions that are shown adjacent to the top organic search results.
metrics.trueview_average_cpv	official_metric	Trueview average cpv	Google Ads API v24 metrics	The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of TrueView views.
metrics.unique_users	official_metric	Unique users	Google Ads API v24 metrics	The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and…
metrics.unique_users_five_plus	official_metric	Unique users five plus	Google Ads API v24 metrics	This metric counts the unique individuals who were shown your video ad five or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
metrics.unique_users_four_plus	official_metric	Unique users four plus	Google Ads API v24 metrics	This metric counts the unique individuals who were shown your video ad four or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
metrics.unique_users_ten_plus	official_metric	Unique users ten plus	Google Ads API v24 metrics	This metric counts the unique individuals who were shown your video ad ten or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
metrics.unique_users_three_plus	official_metric	Unique users three plus	Google Ads API v24 metrics	This metric counts the unique individuals who were shown your video ad three or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
metrics.unique_users_two_plus	official_metric	Unique users two plus	Google Ads API v24 metrics	This metric counts the unique individuals who were shown your video ad two or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
metrics.units_sold	official_metric	Units sold	Google Ads API v24 metrics	Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your…
metrics.valid_accelerated_mobile_pages_clicks_percentage	official_metric	Valid accelerated mobile pages clicks percentage	Google Ads API v24 metrics	The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
metrics.value_adjustment	official_metric	Value adjustment	Google Ads API v24 metrics	The conversion value rule adjustment from biddable conversions in all conversion categories.
metrics.value_per_all_conversions	official_metric	Value per all conversions	Google Ads API v24 metrics	The value of all conversions divided by the number of all conversions.
metrics.value_per_all_conversions_by_conversion_date	official_metric	Value per all conversions by conversion date	Google Ads API v24 metrics	The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with…
metrics.value_per_conversion	official_metric	Value per conversion	Google Ads API v24 metrics	The value of conversions divided by the number of conversions. This only includes conversion actions for which the include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conver…
metrics.value_per_conversions_by_conversion_date	official_metric	Value per conversions by conversion date	Google Ads API v24 metrics	The value of conversions divided by the number of conversions. This only includes conversion actions for which the include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies will optimize for these conver…
metrics.value_per_current_model_attributed_conversion	official_metric	Value per current model attributed conversion	Google Ads API v24 metrics	The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions for which the include_in_conversions_metric attribute is set to true . If you use conversion-based bidding, your bid strategies w…
metrics.value_per_platform_comparable_conversion	official_metric	Value per platform comparable conversion	Google Ads API v24 metrics	The value of platform comparable conversions divided by the number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strate…
metrics.value_per_platform_comparable_conversions_by_conversion_date	official_metric	Value per platform comparable conversions by conversion date	Google Ads API v24 metrics	The value of platform comparable conversions divided by the number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include…
metrics.video_quartile_p100_rate	official_metric	Video quartile p100 rate	Google Ads API v24 metrics	Percentage of impressions where the viewer watched all of your video.
metrics.video_quartile_p25_rate	official_metric	Video quartile p25 rate	Google Ads API v24 metrics	Percentage of impressions where the viewer watched 25% of your video.
metrics.video_quartile_p50_rate	official_metric	Video quartile p50 rate	Google Ads API v24 metrics	Percentage of impressions where the viewer watched 50% of your video.
metrics.video_quartile_p75_rate	official_metric	Video quartile p75 rate	Google Ads API v24 metrics	Percentage of impressions where the viewer watched 75% of your video.
metrics.video_trueview_view_rate	official_metric	Video trueview view rate	Google Ads API v24 metrics	The number of TrueView views your video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
metrics.video_trueview_view_rate_in_feed	official_metric	Video trueview view rate in feed	Google Ads API v24 metrics	The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-feed formats.
metrics.video_trueview_view_rate_in_stream	official_metric	Video trueview view rate in stream	Google Ads API v24 metrics	The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-stream formats.
metrics.video_trueview_view_rate_shorts	official_metric	Video trueview view rate shorts	Google Ads API v24 metrics	The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for Shorts ads.
metrics.video_trueview_views	official_metric	Video trueview views	Google Ads API v24 metrics	The number of TrueView views your video ads received.
metrics.video_watch_time_duration_millis	official_metric	Video watch time duration millis	Google Ads API v24 metrics	Total watch time duration in milliseconds for video impressions that started playing. For a small percentage of impressions, we may not be able to measure the watch time accurately. In such cases, we adjust the total time to account for any unmeasured time by…
metrics.view_through_conversions	official_metric	View through conversions	Google Ads API v24 metrics	The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
metrics.view_through_conversions_from_location_asset_click_to_call	official_metric	View through conversions from location asset click to call	Google Ads API v24 metrics	Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_directions	official_metric	View through conversions from location asset directions	Google Ads API v24 metrics	Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_menu	official_metric	View through conversions from location asset menu	Google Ads API v24 metrics	Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_order	official_metric	View through conversions from location asset order	Google Ads API v24 metrics	Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_other_engagement	official_metric	View through conversions from location asset other engagement	Google Ads API v24 metrics	Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_store_visits	official_metric	View through conversions from location asset store visits	Google Ads API v24 metrics	Estimated number of visits to the business after an impression. This measure is coming from Asset based location.
metrics.view_through_conversions_from_location_asset_website	official_metric	View through conversions from location asset website	Google Ads API v24 metrics	Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
segments.activity_account_id	official_segment	Activity account id	Google Ads API v24 segments	Activity account ID.
segments.activity_city	official_segment	Activity city	Google Ads API v24 segments	The city where the travel activity is available.
segments.activity_country	official_segment	Activity country	Google Ads API v24 segments	The country where the travel activity is available.
segments.activity_rating	official_segment	Activity rating	Google Ads API v24 segments	Activity rating.
segments.activity_state	official_segment	Activity state	Google Ads API v24 segments	The state where the travel activity is available.
segments.ad_destination_type	official_segment	Ad destination type	Google Ads API v24 segments	Ad Destination type.
segments.ad_format_type	official_segment	Ad format type	Google Ads API v24 segments	Ad Format type.
segments.ad_group	official_segment	Ad group	Google Ads API v24 segments	Resource name of the ad group.
segments.ad_network_type	official_segment	Ad network type	Google Ads API v24 segments	Ad network type.
segments.ad_sub_network_type	official_segment	Ad sub network type	Google Ads API v24 segments	Ad sub network type. Currently only available for ads running as part of DemandGen campaigns on YouTube and has to always be selected together with ad_network_type.
segments.ad_using_product_data	official_segment	Ad using product data	Google Ads API v24 segments	Indicates whether an ad is using product data from a Google Merchant Center feed. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
segments.ad_using_video	official_segment	Ad using video	Google Ads API v24 segments	Indicates whether an ad is using a video asset. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
segments.adjusted_age_range	official_segment	Adjusted age range	Google Ads API v24 segments	Adjusted age range. This is the age range of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations ar…
segments.adjusted_gender	official_segment	Adjusted gender	Google Ads API v24 segments	Adjusted gender. This is the gender of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations are only…
segments.asset_group	official_segment	Asset group	Google Ads API v24 segments	Resource name of the asset group.
segments.asset_interaction_target.asset	official_segment	Asset	Google Ads API v24 segments	The asset resource name.
segments.asset_interaction_target.interaction_on_this_asset	official_segment	Interaction on this asset	Google Ads API v24 segments	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.
segments.auction_insight_domain	official_segment	Auction insight domain	Google Ads API v24 segments	Domain (visible URL) of a participant in the Auction Insights report.
segments.budget_campaign_association_status.campaign	official_segment	Campaign	Google Ads API v24 segments	The campaign resource name.
segments.budget_campaign_association_status.status	official_segment	Status	Google Ads API v24 segments	Budget campaign association status.
segments.campaign	official_segment	Campaign	Google Ads API v24 segments	Resource name of the campaign.
segments.click_type	official_segment	Click type	Google Ads API v24 segments	Click type.
segments.conversion_action	official_segment	Conversion action	Google Ads API v24 segments	Resource name of the conversion action.
segments.conversion_action_category	official_segment	Conversion action category	Google Ads API v24 segments	Conversion action category.
segments.conversion_action_name	official_segment	Conversion action name	Google Ads API v24 segments	Conversion action name.
segments.conversion_adjustment	official_segment	Conversion adjustment	Google Ads API v24 segments	This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated.…
segments.conversion_attribution_event_type	official_segment	Conversion attribution event type	Google Ads API v24 segments	Conversion attribution event type.
segments.conversion_lag_bucket	official_segment	Conversion lag bucket	Google Ads API v24 segments	An enum value representing the number of days between the impression and the conversion.
segments.conversion_or_adjustment_lag_bucket	official_segment	Conversion or adjustment lag bucket	Google Ads API v24 segments	An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
segments.conversion_value_rule_primary_dimension	official_segment	Conversion value rule primary dimension	Google Ads API v24 segments	Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DE…
segments.date	official_segment	Date	Google Ads API v24 segments	Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
segments.day_of_week	official_segment	Day of week	Google Ads API v24 segments	Day of the week, for example, MONDAY.
segments.device	official_segment	Device	Google Ads API v24 segments	Device to which metrics apply.
segments.external_activity_id	official_segment	External activity id	Google Ads API v24 segments	Advertiser supplied activity ID.
segments.external_conversion_source	official_segment	External conversion source	Google Ads API v24 segments	External conversion source.
segments.geo_target_airport	official_segment	Geo target airport	Google Ads API v24 segments	Resource name of the geo target constant that represents an airport.
segments.geo_target_canton	official_segment	Geo target canton	Google Ads API v24 segments	Resource name of the geo target constant that represents a canton.
segments.geo_target_city	official_segment	Geo target city	Google Ads API v24 segments	Resource name of the geo target constant that represents a city.
segments.geo_target_country	official_segment	Geo target country	Google Ads API v24 segments	Resource name of the geo target constant that represents a country.
segments.geo_target_county	official_segment	Geo target county	Google Ads API v24 segments	Resource name of the geo target constant that represents a county.
segments.geo_target_district	official_segment	Geo target district	Google Ads API v24 segments	Resource name of the geo target constant that represents a district.
segments.geo_target_metro	official_segment	Geo target metro	Google Ads API v24 segments	Resource name of the geo target constant that represents a metro.
segments.geo_target_most_specific_location	official_segment	Geo target most specific location	Google Ads API v24 segments	Resource name of the geo target constant that represents the most specific location.
segments.geo_target_postal_code	official_segment	Geo target postal code	Google Ads API v24 segments	Resource name of the geo target constant that represents a postal code.
segments.geo_target_province	official_segment	Geo target province	Google Ads API v24 segments	Resource name of the geo target constant that represents a province.
segments.geo_target_region	official_segment	Geo target region	Google Ads API v24 segments	Resource name of the geo target constant that represents a region.
segments.geo_target_state	official_segment	Geo target state	Google Ads API v24 segments	Resource name of the geo target constant that represents a state.
segments.hotel_booking_window_days	official_segment	Hotel booking window days	Google Ads API v24 segments	Hotel booking window in days.
segments.hotel_center_id	official_segment	Hotel center id	Google Ads API v24 segments	Hotel center ID.
segments.hotel_check_in_date	official_segment	Hotel check in date	Google Ads API v24 segments	Hotel check-in date. Formatted as yyyy-MM-dd.
segments.hotel_check_in_day_of_week	official_segment	Hotel check in day of week	Google Ads API v24 segments	Hotel check-in day of week.
segments.hotel_city	official_segment	Hotel city	Google Ads API v24 segments	Hotel city.
segments.hotel_class	official_segment	Hotel class	Google Ads API v24 segments	Hotel class.
segments.hotel_country	official_segment	Hotel country	Google Ads API v24 segments	Hotel country.
segments.hotel_date_selection_type	official_segment	Hotel date selection type	Google Ads API v24 segments	Hotel date selection type.
segments.hotel_length_of_stay	official_segment	Hotel length of stay	Google Ads API v24 segments	Hotel length of stay.
segments.hotel_price_bucket	official_segment	Hotel price bucket	Google Ads API v24 segments	Hotel price bucket.
segments.hotel_rate_rule_id	official_segment	Hotel rate rule id	Google Ads API v24 segments	Hotel rate rule ID.
segments.hotel_rate_type	official_segment	Hotel rate type	Google Ads API v24 segments	Hotel rate type.
segments.hotel_state	official_segment	Hotel state	Google Ads API v24 segments	Hotel state.
segments.hour	official_segment	Hour	Google Ads API v24 segments	Hour of day as a number between 0 and 23, inclusive.
segments.interaction_on_this_extension	official_segment	Interaction on this extension	Google Ads API v24 segments	Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
segments.keyword.ad_group_criterion	official_segment	Ad group criterion	Google Ads API v24 segments	The AdGroupCriterion resource name.
segments.keyword.info.match_type	official_segment	Match type	Google Ads API v24 segments	The match type of the keyword.
segments.keyword.info.text	official_segment	Text	Google Ads API v24 segments	The text of the keyword (at most 80 characters and 10 words).
segments.landing_page_source	official_segment	Landing page source	Google Ads API v24 segments	The source of a landing page in the landing page report.
segments.match_type	official_segment	Match type	Google Ads API v24 segments	The match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use search_term_match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Nea…
segments.mobile_device_platform	official_segment	Mobile device platform	Google Ads API v24 segments	Mobile device platform to which metrics apply.
segments.month	official_segment	Month	Google Ads API v24 segments	Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
segments.month_of_year	official_segment	Month of year	Google Ads API v24 segments	Month of the year, for example, January.
segments.new_versus_returning_customers	official_segment	New versus returning customers	Google Ads API v24 segments	This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal.
segments.partner_hotel_id	official_segment	Partner hotel id	Google Ads API v24 segments	Partner hotel ID.
segments.product_aggregator_id	official_segment	Product aggregator id	Google Ads API v24 segments	Aggregator ID of the product.
segments.product_brand	official_segment	Product brand	Google Ads API v24 segments	Brand of the product.
segments.product_category_level1	official_segment	Product category level1	Google Ads API v24 segments	Category (level 1) of the product.
segments.product_category_level2	official_segment	Product category level2	Google Ads API v24 segments	Category (level 2) of the product.
segments.product_category_level3	official_segment	Product category level3	Google Ads API v24 segments	Category (level 3) of the product.
segments.product_category_level4	official_segment	Product category level4	Google Ads API v24 segments	Category (level 4) of the product.
segments.product_category_level5	official_segment	Product category level5	Google Ads API v24 segments	Category (level 5) of the product.
segments.product_channel	official_segment	Product channel	Google Ads API v24 segments	Channel of the product.
segments.product_channel_exclusivity	official_segment	Product channel exclusivity	Google Ads API v24 segments	Channel exclusivity of the product.
segments.product_condition	official_segment	Product condition	Google Ads API v24 segments	Condition of the product.
segments.product_country	official_segment	Product country	Google Ads API v24 segments	Resource name of the geo target constant for the country of sale of the product.
segments.product_custom_attribute0	official_segment	Product custom attribute0	Google Ads API v24 segments	Custom attribute 0 of the product.
segments.product_custom_attribute1	official_segment	Product custom attribute1	Google Ads API v24 segments	Custom attribute 1 of the product.
segments.product_custom_attribute2	official_segment	Product custom attribute2	Google Ads API v24 segments	Custom attribute 2 of the product.
segments.product_custom_attribute3	official_segment	Product custom attribute3	Google Ads API v24 segments	Custom attribute 3 of the product.
segments.product_custom_attribute4	official_segment	Product custom attribute4	Google Ads API v24 segments	Custom attribute 4 of the product.
segments.product_feed_label	official_segment	Product feed label	Google Ads API v24 segments	Feed label of the product.
segments.product_item_id	official_segment	Product item id	Google Ads API v24 segments	Item ID of the product.
segments.product_language	official_segment	Product language	Google Ads API v24 segments	Resource name of the language constant for the language of the product.
segments.product_merchant_id	official_segment	Product merchant id	Google Ads API v24 segments	Merchant ID of the product.
segments.product_sold_brand	official_segment	Product sold brand	Google Ads API v24 segments	Brand of the product sold.
segments.product_sold_category_level1	official_segment	Product sold category level1	Google Ads API v24 segments	Category (level 1) of the product sold.
segments.product_sold_category_level2	official_segment	Product sold category level2	Google Ads API v24 segments	Category (level 2) of the product sold.
segments.product_sold_category_level3	official_segment	Product sold category level3	Google Ads API v24 segments	Category (level 3) of the product sold.
segments.product_sold_category_level4	official_segment	Product sold category level4	Google Ads API v24 segments	Category (level 4) of the product sold.
segments.product_sold_category_level5	official_segment	Product sold category level5	Google Ads API v24 segments	Category (level 5) of the product sold.
segments.product_sold_condition	official_segment	Product sold condition	Google Ads API v24 segments	Condition of the product sold.
segments.product_sold_custom_attribute0	official_segment	Product sold custom attribute0	Google Ads API v24 segments	Custom attribute 0 of the product sold.
segments.product_sold_custom_attribute1	official_segment	Product sold custom attribute1	Google Ads API v24 segments	Custom attribute 1 of the product sold.
segments.product_sold_custom_attribute2	official_segment	Product sold custom attribute2	Google Ads API v24 segments	Custom attribute 2 of the product sold.
segments.product_sold_custom_attribute3	official_segment	Product sold custom attribute3	Google Ads API v24 segments	Custom attribute 3 of the product sold.
segments.product_sold_custom_attribute4	official_segment	Product sold custom attribute4	Google Ads API v24 segments	Custom attribute 4 of the product sold.
segments.product_sold_item_id	official_segment	Product sold item id	Google Ads API v24 segments	Item ID of the product sold.
segments.product_sold_title	official_segment	Product sold title	Google Ads API v24 segments	Title of the product sold.
segments.product_sold_type_l1	official_segment	Product sold type l1	Google Ads API v24 segments	Type (level 1) of the product sold.
segments.product_sold_type_l2	official_segment	Product sold type l2	Google Ads API v24 segments	Type (level 2) of the product sold.
segments.product_sold_type_l3	official_segment	Product sold type l3	Google Ads API v24 segments	Type (level 3) of the product sold.
segments.product_sold_type_l4	official_segment	Product sold type l4	Google Ads API v24 segments	Type (level 4) of the product sold.
segments.product_sold_type_l5	official_segment	Product sold type l5	Google Ads API v24 segments	Type (level 5) of the product sold.
segments.product_store_id	official_segment	Product store id	Google Ads API v24 segments	Store ID of the product.
segments.product_title	official_segment	Product title	Google Ads API v24 segments	Title of the product.
segments.product_type_l1	official_segment	Product type l1	Google Ads API v24 segments	Type (level 1) of the product.
segments.product_type_l2	official_segment	Product type l2	Google Ads API v24 segments	Type (level 2) of the product.
segments.product_type_l3	official_segment	Product type l3	Google Ads API v24 segments	Type (level 3) of the product.
segments.product_type_l4	official_segment	Product type l4	Google Ads API v24 segments	Type (level 4) of the product.
segments.product_type_l5	official_segment	Product type l5	Google Ads API v24 segments	Type (level 5) of the product.
segments.quarter	official_segment	Quarter	Google Ads API v24 segments	Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
segments.recommendation_type	official_segment	Recommendation type	Google Ads API v24 segments	Recommendation type.
segments.search_engine_results_page_type	official_segment	Search engine results page type	Google Ads API v24 segments	Type of the search engine results page.
segments.search_subcategory	official_segment	Search subcategory	Google Ads API v24 segments	A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.
segments.search_term	official_segment	Search term	Google Ads API v24 segments	A search term.
segments.search_term_match_source	official_segment	Search term match source	Google Ads API v24 segments	Specifies the source for how the search term was matched, which reveals the type of ad campaign responsible. Use this to distinguish between automated campaigns (like AI Max, Dynamic Search Ads) and keyword-based campaigns (Standard).
segments.search_term_match_type	official_segment	Search term match type	Google Ads API v24 segments	Match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Near Exact and Near…
segments.search_term_targeting_status	official_segment	Search term targeting status	Google Ads API v24 segments	Indicates whether the search term is currently one of your targeted or excluded keywords.
segments.sk_ad_network_ad_event_type	official_segment	Sk ad network ad event type	Google Ads API v24 segments	iOS Store Kit Ad Network ad event type.
segments.sk_ad_network_attribution_credit	official_segment	Sk ad network attribution credit	Google Ads API v24 segments	iOS Store Kit Ad Network attribution credit
segments.sk_ad_network_coarse_conversion_value	official_segment	Sk ad network coarse conversion value	Google Ads API v24 segments	iOS Store Kit Ad Network coarse conversion value.
segments.sk_ad_network_fine_conversion_value	official_segment	Sk ad network fine conversion value	Google Ads API v24 segments	iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
segments.sk_ad_network_postback_sequence_index	official_segment	Sk ad network postback sequence index	Google Ads API v24 segments	iOS Store Kit Ad Network postback sequence index.
segments.sk_ad_network_redistributed_fine_conversion_value	official_segment	Sk ad network redistributed fine conversion value	Google Ads API v24 segments	iOS Store Kit Ad Network redistributed fine conversion value. Google uses modeling on observed conversion values(obtained from Apple) to calculate conversions from SKAN postbacks where NULLs are returned. This column represents the sum of the modeled conversi…
segments.sk_ad_network_source_app.sk_ad_network_source_app_id	official_segment	Sk ad network source app id	Google Ads API v24 segments	App id where the ad that drove the iOS Store Kit Ad Network install was shown.
segments.sk_ad_network_source_domain	official_segment	Sk ad network source domain	Google Ads API v24 segments	Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
segments.sk_ad_network_source_type	official_segment	Sk ad network source type	Google Ads API v24 segments	The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple.
segments.sk_ad_network_user_type	official_segment	Sk ad network user type	Google Ads API v24 segments	iOS Store Kit Ad Network user type.
segments.sk_ad_network_version	official_segment	Sk ad network version	Google Ads API v24 segments	The version of the SKAdNetwork API used.
segments.slot	official_segment	Slot	Google Ads API v24 segments	Position of the ad.
segments.travel_destination_city	official_segment	Travel destination city	Google Ads API v24 segments	The city the user is searching for at query time.
segments.travel_destination_country	official_segment	Travel destination country	Google Ads API v24 segments	The country the user is searching for at query time.
segments.travel_destination_region	official_segment	Travel destination region	Google Ads API v24 segments	The region the user is searching for at query time.
segments.vertical_ads_event_participant_display_names	official_segment	Vertical ads event participant display names	Google Ads API v24 segments	The display names of participants in an event listing, like performers, speakers, or teams.
segments.vertical_ads_hotel_class	official_segment	Vertical ads hotel class	Google Ads API v24 segments	The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.
segments.vertical_ads_listing	official_segment	Vertical ads listing	Google Ads API v24 segments	The listing associated with a listing impression, click or conversion.
segments.vertical_ads_listing_brand	official_segment	Vertical ads listing brand	Google Ads API v24 segments	The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event.
segments.vertical_ads_listing_city	official_segment	Vertical ads listing city	Google Ads API v24 segments	The city where the vertical ads listing is located.
segments.vertical_ads_listing_country	official_segment	Vertical ads listing country	Google Ads API v24 segments	The country where the vertical ads listing is located.
segments.vertical_ads_listing_region	official_segment	Vertical ads listing region	Google Ads API v24 segments	The region where the vertical ads listing is located.
segments.vertical_ads_listing_user_rating	official_segment	Vertical ads listing user rating	Google Ads API v24 segments	Integer value specifying the user rating of the vertical ads listing as a number from 1 to 5, where 5 is the best. The value will always be within this range.
segments.vertical_ads_listing_venue	official_segment	Vertical ads listing venue	Google Ads API v24 segments	The name of the venue for the vertical ads listing, for example, the venue for a concert event.
segments.vertical_ads_partner_account	official_segment	Vertical ads partner account	Google Ads API v24 segments	A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.
segments.vertical_ads_vertical	official_segment	Vertical ads vertical	Google Ads API v24 segments	Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.
segments.webpage	official_segment	Webpage	Google Ads API v24 segments	Resource name of the ad group criterion that represents webpage criterion.
segments.week	official_segment	Week	Google Ads API v24 segments	Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
segments.year	official_segment	Year	Google Ads API v24 segments	Year, formatted as yyyy.
customer.auto_tagging_enabled	official_attribute	Auto tagging enabled	Google Ads API v24 customer	Whether auto-tagging is enabled for the customer. Only mutable in an update operation.
customer.call_reporting_setting.call_conversion_action	official_attribute	Call conversion action	Google Ads API v24 customer	Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
customer.call_reporting_setting.call_conversion_reporting_enabled	official_attribute	Call conversion reporting enabled	Google Ads API v24 customer	Whether to enable call conversion reporting.
customer.call_reporting_setting.call_reporting_enabled	official_attribute	Call reporting enabled	Google Ads API v24 customer	Enable reporting of phone call events by redirecting them through Google System.
customer.contains_eu_political_advertising	official_attribute	Contains eu political advertising	Google Ads API v24 customer	Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update t…
customer.conversion_tracking_setting.accepted_customer_data_terms	official_attribute	Accepted customer data terms	Google Ads API v24 customer	Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 .
customer.conversion_tracking_setting.conversion_tracking_id	official_attribute	Conversion tracking id	Google Ads API v24 customer	Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
customer.conversion_tracking_setting.conversion_tracking_status	official_attribute	Conversion tracking status	Google Ads API v24 customer	Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ bas…
customer.conversion_tracking_setting.cross_account_conversion_tracking_id	official_attribute	Cross account conversion tracking id	Google Ads API v24 customer	Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is…
customer.conversion_tracking_setting.enhanced_conversions_for_leads_enabled	official_attribute	Enhanced conversions for leads enabled	Google Ads API v24 customer	Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
customer.conversion_tracking_setting.google_ads_conversion_customer	official_attribute	Google ads conversion customer	Google Ads API v24 customer	The resource name of the customer where conversions are created and managed. This field is read-only.
customer.currency_code	official_attribute	Currency code	Google Ads API v24 customer	Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
customer.customer_agreement_setting.accepted_lead_form_terms	official_attribute	Accepted lead form terms	Google Ads API v24 customer	Output only. Whether the customer has accepted lead form term of service.
customer.descriptive_name	official_attribute	Descriptive name	Google Ads API v24 customer	Optional, non-unique descriptive name of the customer.
customer.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 customer	The URL template for appending params to the final URL. Only mutable in an update operation.
customer.has_partners_badge	official_attribute	Has partners badge	Google Ads API v24 customer	Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 .
customer.id	official_attribute	Id	Google Ads API v24 customer	Output only. The ID of the customer.
customer.image_asset_auto_migration_done	official_attribute	Image asset auto migration done	Google Ads API v24 customer	Output only. True if feed based image has been migrated to asset based image.
customer.image_asset_auto_migration_done_date_time	official_attribute	Image asset auto migration done date time	Google Ads API v24 customer	Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
customer.local_services_settings.granular_insurance_statuses	official_attribute	Granular insurance statuses	Google Ads API v24 customer	Output only. A read-only list of geo vertical level insurance statuses.
customer.local_services_settings.granular_license_statuses	official_attribute	Granular license statuses	Google Ads API v24 customer	Output only. A read-only list of geo vertical level license statuses.
customer.location_asset_auto_migration_done	official_attribute	Location asset auto migration done	Google Ads API v24 customer	Output only. True if feed based location has been migrated to asset based location.
customer.location_asset_auto_migration_done_date_time	official_attribute	Location asset auto migration done date time	Google Ads API v24 customer	Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
customer.manager	official_attribute	Manager	Google Ads API v24 customer	Output only. Whether the customer is a manager.
customer.optimization_score	official_attribute	Optimization score	Google Ads API v24 customer	Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager custome…
customer.optimization_score_weight	official_attribute	Optimization score weight	Google Ads API v24 customer	Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of thei…
customer.pay_per_conversion_eligibility_failure_reasons	official_attribute	Pay per conversion eligibility failure reasons	Google Ads API v24 customer	Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
customer.remarketing_setting.google_global_site_tag	official_attribute	Google global site tag	Google Ads API v24 customer	Output only. The Google tag.
customer.resource_name	official_attribute	Resource name	Google Ads API v24 customer	Immutable. The resource name of the customer. Customer resource names have the form: customers/{customer_id}
customer.status	official_attribute	Status	Google Ads API v24 customer	Output only. The status of the customer.
customer.test_account	official_attribute	Test account	Google Ads API v24 customer	Output only. Whether the customer is a test account.
customer.time_zone	official_attribute	Time zone	Google Ads API v24 customer	Immutable. The local timezone ID of the customer.
customer.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 customer	The URL template for constructing a tracking URL out of parameters. Only mutable in an update operation.
customer.video_brand_safety_suitability	official_attribute	Video brand safety suitability	Google Ads API v24 customer	Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513 .
customer.video_customer.third_party_integration_partners.brand_lift_integration_partners	official_attribute	Brand lift integration partners	Google Ads API v24 customer	Allowed third party integration partners for Brand Lift verification.
customer.video_customer.third_party_integration_partners.brand_safety_integration_partners	official_attribute	Brand safety integration partners	Google Ads API v24 customer	Allowed third party integration partners for brand safety verification.
customer.video_customer.third_party_integration_partners.reach_integration_partners	official_attribute	Reach integration partners	Google Ads API v24 customer	Allowed third party integration partners for reach verification.
customer.video_customer.third_party_integration_partners.viewability_integration_partners	official_attribute	Viewability integration partners	Google Ads API v24 customer	Allowed third party integration partners for YouTube viewability verification.
campaign.accessible_bidding_strategy	official_attribute	Accessible bidding strategy	Google Ads API v24 campaign	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 strate…
campaign.ad_serving_optimization_status	official_attribute	Ad serving optimization status	Google Ads API v24 campaign	The ad serving optimization status of the campaign.
campaign.advertising_channel_sub_type	official_attribute	Advertising channel sub type	Google Ads API v24 campaign	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.
campaign.advertising_channel_type	official_attribute	Advertising channel type	Google Ads API v24 campaign	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 campai…
campaign.ai_max_setting.bundling_required	official_attribute	Bundling required	Google Ads API v24 campaign	Output only. Search campaigns only. Indicates whether a campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
campaign.ai_max_setting.enable_ai_max	official_attribute	Enable ai max	Google Ads API v24 campaign	Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regar…
campaign.app_campaign_setting.app_id	official_attribute	App id	Google Ads API v24 campaign	Immutable. A string that uniquely identifies a mobile application.
campaign.app_campaign_setting.app_store	official_attribute	App store	Google Ads API v24 campaign	Immutable. The application store that distributes this specific app.
campaign.app_campaign_setting.bidding_strategy_goal_type	official_attribute	Bidding strategy goal type	Google Ads API v24 campaign	Represents the goal which the bidding strategy of this app campaign should optimize towards.
campaign.asset_automation_settings	official_attribute	Asset automation settings	Google Ads API v24 campaign	Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
campaign.audience_setting.use_audience_grouped	official_attribute	Use audience grouped	Google Ads API v24 campaign	Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
campaign.base_campaign	official_attribute	Base campaign	Google Ads API v24 campaign	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.
campaign.bidding_strategy	official_attribute	Bidding strategy	Google Ads API v24 campaign	The resource name of the portfolio bidding strategy used by the campaign.
campaign.bidding_strategy_system_status	official_attribute	Bidding strategy system status	Google Ads API v24 campaign	Output only. The system status of the campaign's bidding strategy.
campaign.bidding_strategy_type	official_attribute	Bidding strategy type	Google Ads API v24 campaign	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.
campaign.brand_guidelines.accent_color	official_attribute	Accent color	Google Ads API v24 campaign	The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
campaign.brand_guidelines.main_color	official_attribute	Main color	Google Ads API v24 campaign	The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
campaign.brand_guidelines.predefined_font_family	official_attribute	Predefined font family	Google Ads API v24 campaign	The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
campaign.brand_guidelines_enabled	official_attribute	Brand guidelines enabled	Google Ads API v24 campaign	Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets. Writable only at campaign creation. Set to…
campaign.campaign_budget	official_attribute	Campaign budget	Google Ads API v24 campaign	The resource name of the campaign budget of the campaign.
campaign.campaign_group	official_attribute	Campaign group	Google Ads API v24 campaign	The resource name of the campaign group that this campaign belongs to.
campaign.commission.commission_rate_micros	official_attribute	Commission rate micros	Google Ads API v24 campaign	Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).
campaign.contains_eu_political_advertising	official_attribute	Contains eu political advertising	Google Ads API v24 campaign	The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
campaign.demand_gen_campaign_settings.upgraded_targeting	official_attribute	Upgraded targeting	Google Ads API v24 campaign	Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to true , you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to true , a…
campaign.dynamic_search_ads_setting.domain_name	official_attribute	Domain name	Google Ads API v24 campaign	Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
campaign.dynamic_search_ads_setting.language_code	official_attribute	Language code	Google Ads API v24 campaign	Required. The language code specifying the language of the domain, for example, "en".
campaign.dynamic_search_ads_setting.use_supplied_urls_only	official_attribute	Use supplied urls only	Google Ads API v24 campaign	Whether the campaign uses advertiser supplied URLs exclusively.
campaign.end_date_time	official_attribute	End date time	Google Ads API v24 campaign	The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefini…
campaign.excluded_parent_asset_field_types	official_attribute	Excluded parent asset field types	Google Ads API v24 campaign	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.
campaign.excluded_parent_asset_set_types	official_attribute	Excluded parent asset set types	Google Ads API v24 campaign	The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_G…
campaign.experiment_type	official_attribute	Experiment type	Google Ads API v24 campaign	Output only. The type of campaign: normal, draft, or experiment.
campaign.feed_types	official_attribute	Feed types	Google Ads API v24 campaign	Output only. Types of feeds that are attached directly to this campaign.
campaign.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 campaign	Suffix used to append query parameters to landing pages that are served with parallel tracking.
campaign.fixed_cpm.goal	official_attribute	Goal	Google Ads API v24 campaign	Fixed CPM bidding goal. Determines the exact bidding optimization parameters.
campaign.fixed_cpm.target_frequency_info.target_count	official_attribute	Target count	Google Ads API v24 campaign	Target frequency count represents the number of times an advertiser wants to show the ad to target a single user.
campaign.fixed_cpm.target_frequency_info.time_unit	official_attribute	Time unit	Google Ads API v24 campaign	Time window expressing the period over which you want to reach the specified target_count.
campaign.frequency_caps	official_attribute	Frequency caps	Google Ads API v24 campaign	A list that limits how often each user will see this campaign's ads.
campaign.geo_target_type_setting.negative_geo_target_type	official_attribute	Negative geo target type	Google Ads API v24 campaign	The setting used for negative geotargeting in this particular campaign.
campaign.geo_target_type_setting.positive_geo_target_type	official_attribute	Positive geo target type	Google Ads API v24 campaign	The setting used for positive geotargeting in this particular campaign.
campaign.hotel_property_asset_set	official_attribute	Hotel property asset set	Google Ads API v24 campaign	Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
campaign.hotel_setting.disable_hotel_setting	official_attribute	Disable hotel setting	Google Ads API v24 campaign	Disable the optional hotel setting. This field is currently supported only for Demand Gen campaigns.
campaign.hotel_setting.hotel_center_id	official_attribute	Hotel center id	Google Ads API v24 campaign	The linked Hotel Center account.
campaign.id	official_attribute	Id	Google Ads API v24 campaign	Output only. The ID of the campaign.
campaign.keyword_match_type	official_attribute	Keyword match type	Google Ads API v24 campaign	Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
campaign.labels	official_attribute	Labels	Google Ads API v24 campaign	Output only. The resource names of labels attached to this campaign.
campaign.listing_type	official_attribute	Listing type	Google Ads API v24 campaign	Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
campaign.local_campaign_setting.location_source_type	official_attribute	Location source type	Google Ads API v24 campaign	The location source type for this local campaign.
campaign.local_services_campaign_settings.category_bids	official_attribute	Category bids	Google Ads API v24 campaign	Categorical level bids associated with MANUAL_CPA bidding strategy.
campaign.manual_cpa	official_attribute	Manual cpa	Google Ads API v24 campaign	Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
campaign.manual_cpc.enhanced_cpc_enabled	official_attribute	Enhanced cpc enabled	Google Ads API v24 campaign	Whether bids are to be enhanced based on conversion optimizer data.
campaign.manual_cpm	official_attribute	Manual cpm	Google Ads API v24 campaign	Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
campaign.manual_cpv	official_attribute	Manual cpv	Google Ads API v24 campaign	A bidding strategy that pays a configurable amount per video view.
campaign.maximize_conversion_value.target_roas	official_attribute	Target roas	Google Ads API v24 campaign	The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, th…
campaign.maximize_conversion_value.target_roas_tolerance_percent_millis	official_attribute	Target roas tolerance percent millis	Google Ads API v24 campaign	The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up…
campaign.maximize_conversions.target_cpa_micros	official_attribute	Target cpa micros	Google Ads API v24 campaign	The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below t…
campaign.missing_eu_political_advertising_declaration	official_attribute	Missing eu political advertising declaration	Google Ads API v24 campaign	Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add t…
campaign.name	official_attribute	Name	Google Ads API v24 campaign	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.
campaign.network_settings.target_content_network	official_attribute	Target content network	Google Ads API v24 campaign	Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
campaign.network_settings.target_google_search	official_attribute	Target google search	Google Ads API v24 campaign	Whether ads will be served with google.com search results.
campaign.network_settings.target_google_tv_network	official_attribute	Target google tv network	Google Ads API v24 campaign	Whether ads will be served on the Google TV network.
campaign.network_settings.target_partner_search_network	official_attribute	Target partner search network	Google Ads API v24 campaign	Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google…
campaign.network_settings.target_search_network	official_attribute	Target search network	Google Ads API v24 campaign	Whether ads will be served on sites in the Google Search Partners Network (requires target_google_search to also be true ).
campaign.network_settings.target_youtube	official_attribute	Target youtube	Google Ads API v24 campaign	Whether ads will be served on YouTube.
campaign.optimization_goal_setting.optimization_goal_types	official_attribute	Optimization goal types	Google Ads API v24 campaign	The list of optimization goal types.
campaign.optimization_score	official_attribute	Optimization score	Google Ads API v24 campaign	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…
campaign.payment_mode	official_attribute	Payment mode	Google Ads API v24 campaign	Payment mode for the campaign.
campaign.percent_cpc.cpc_bid_ceiling_micros	official_attribute	Cpc bid ceiling micros	Google Ads API v24 campaign	Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
campaign.percent_cpc.enhanced_cpc_enabled	official_attribute	Enhanced cpc enabled	Google Ads API v24 campaign	Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
campaign.performance_max_upgrade.performance_max_campaign	official_attribute	Performance max campaign	Google Ads API v24 campaign	Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
campaign.performance_max_upgrade.pre_upgrade_campaign	official_attribute	Pre upgrade campaign	Google Ads API v24 campaign	Output only. The resource name of the legacy campaign upgraded to Performance Max.
campaign.performance_max_upgrade.status	official_attribute	Status	Google Ads API v24 campaign	Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
campaign.pmax_campaign_settings.brand_targeting_overrides.ignore_exclusions_for_shopping_ads	official_attribute	Ignore exclusions for shopping ads	Google Ads API v24 campaign	If true, brand exclusions are ignored for Shopping ads.
campaign.pmax_campaign_settings.local_services_enabled	official_attribute	Local services enabled	Google Ads API v24 campaign	Output only. Indicates whether the Performance Max campaign is a Local Services campaign.
campaign.pmax_campaign_settings.local_services_pmax_campaign_settings.country_code	official_attribute	Country code	Google Ads API v24 campaign	Immutable. Country code of the Local Services Ad. Set once during Ad Creation and used to determine verification requirements and validate location criterion selection; upper-case, two-letter codes as defined by ISO-3166.
campaign.pmax_campaign_settings.local_services_pmax_campaign_settings.founding_year	official_attribute	Founding year	Google Ads API v24 campaign	Founding year of the business.
campaign.pmax_campaign_settings.local_services_pmax_campaign_settings.navigational_query_leads_enabled	official_attribute	Navigational query leads enabled	Google Ads API v24 campaign	Whether to use navigational query filter.
campaign.pmax_campaign_settings.local_services_pmax_campaign_settings.phone_numbers	official_attribute	Phone numbers	Google Ads API v24 campaign	List of phone numbers associated with the provider.
campaign.primary_status	official_attribute	Primary status	Google Ads API v24 campaign	Output only. The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.
campaign.primary_status_reasons	official_attribute	Primary status reasons	Google Ads API v24 campaign	Output only. The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.
campaign.real_time_bidding_setting.opt_in	official_attribute	Opt in	Google Ads API v24 campaign	Whether the campaign is opted in to real-time bidding.
campaign.resource_name	official_attribute	Resource name	Google Ads API v24 campaign	Immutable. The resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}
campaign.selective_optimization.conversion_actions	official_attribute	Conversion actions	Google Ads API v24 campaign	The selected set of resource names for conversion actions for optimizing this campaign.
campaign.serving_status	official_attribute	Serving status	Google Ads API v24 campaign	Output only. The ad serving status of the campaign.
campaign.shopping_setting.advertising_partner_ids	official_attribute	Advertising partner ids	Google Ads API v24 campaign	The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. Once set, the field is immutable. This feature is currently supported only f…
campaign.shopping_setting.campaign_priority	official_attribute	Campaign priority	Google Ads API v24 campaign	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…
campaign.shopping_setting.disable_product_feed	official_attribute	Disable product feed	Google Ads API v24 campaign	Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.
campaign.shopping_setting.enable_local	official_attribute	Enable local	Google Ads API v24 campaign	Whether to include local products.
campaign.shopping_setting.feed_label	official_attribute	Feed label	Google Ads API v24 campaign	Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated sales_country in the two-letter country code ( XX…
campaign.shopping_setting.ignore_brand_exclusion_in_shopping_ads	official_attribute	Ignore brand exclusion in shopping ads	Google Ads API v24 campaign	If true, brand exclusions are ignored for Shopping ads. Only supported for Shopping campaigns.
campaign.shopping_setting.merchant_id	official_attribute	Merchant id	Google Ads API v24 campaign	ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
campaign.shopping_setting.use_vehicle_inventory	official_attribute	Use vehicle inventory	Google Ads API v24 campaign	Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use listing_type instead.
campaign.start_date_time	official_attribute	Start date time	Google Ads API v24 campaign	The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
campaign.status	official_attribute	Status	Google Ads API v24 campaign	The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
campaign.target_cpa.cpc_bid_ceiling_micros	official_attribute	Cpc bid ceiling micros	Google Ads API v24 campaign	Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
campaign.target_cpa.cpc_bid_floor_micros	official_attribute	Cpc bid floor micros	Google Ads API v24 campaign	Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
campaign.target_cpa.target_cpa_micros	official_attribute	Target cpa micros	Google Ads API v24 campaign	Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
campaign.target_cpc.target_cpc_micros	official_attribute	Target cpc micros	Google Ads API v24 campaign	Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
campaign.target_cpm.target_frequency_goal.target_count	official_attribute	Target count	Google Ads API v24 campaign	Target Frequency count representing how many times you want to reach a single user.
campaign.target_cpm.target_frequency_goal.time_unit	official_attribute	Time unit	Google Ads API v24 campaign	Time window expressing the period over which you want to reach the specified target_count.
campaign.target_cpv	official_attribute	Target cpv	Google Ads API v24 campaign	An automated bidding strategy that sets bids to optimize performance given the target CPV you set.
campaign.target_impression_share.cpc_bid_ceiling_micros	official_attribute	Cpc bid ceiling micros	Google Ads API v24 campaign	The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
campaign.target_impression_share.location	official_attribute	Location	Google Ads API v24 campaign	The targeted location on the search results page.
campaign.target_impression_share.location_fraction_micros	official_attribute	Location fraction micros	Google Ads API v24 campaign	The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
campaign.target_roas.cpc_bid_ceiling_micros	official_attribute	Cpc bid ceiling micros	Google Ads API v24 campaign	Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
campaign.target_roas.cpc_bid_floor_micros	official_attribute	Cpc bid floor micros	Google Ads API v24 campaign	Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
campaign.target_roas.target_roas	official_attribute	Target roas	Google Ads API v24 campaign	Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
campaign.target_roas.target_roas_tolerance_percent_millis	official_attribute	Target roas tolerance percent millis	Google Ads API v24 campaign	The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up…
campaign.target_spend.cpc_bid_ceiling_micros	official_attribute	Cpc bid ceiling micros	Google Ads API v24 campaign	Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
campaign.target_spend.target_spend_micros	official_attribute	Target spend micros	Google Ads API v24 campaign	Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and sh…
campaign.targeting_setting.target_restrictions	official_attribute	Target restrictions	Google Ads API v24 campaign	The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
campaign.text_guidelines.messaging_restrictions	official_attribute	Messaging restrictions	Google Ads API v24 campaign	Freeform instructions that will be used to guide text asset generation using LLM inference. At most 40 restrictions may be provided.
campaign.text_guidelines.term_exclusions	official_attribute	Term exclusions	Google Ads API v24 campaign	Exact words or phrases that will be excluded from generated text assets. At most 25 exclusions may be provided. Valid exclusions may contain a maximum of 30 characters.
campaign.third_party_integration_partners.brand_lift_integration_partners	official_attribute	Brand lift integration partners	Google Ads API v24 campaign	Third party integration partners for Brand Lift verification for this Campaign.
campaign.third_party_integration_partners.brand_safety_integration_partners	official_attribute	Brand safety integration partners	Google Ads API v24 campaign	Third party integration partners for brand safety verification for this Campaign.
campaign.third_party_integration_partners.reach_integration_partners	official_attribute	Reach integration partners	Google Ads API v24 campaign	Third party integration partners for reach verification for this Campaign.
campaign.third_party_integration_partners.viewability_integration_partners	official_attribute	Viewability integration partners	Google Ads API v24 campaign	Third party integration partners for YouTube viewability verification for this Campaign.
campaign.tracking_setting.tracking_url	official_attribute	Tracking url	Google Ads API v24 campaign	Output only. The url used for dynamic tracking.
campaign.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 campaign	The URL template for constructing a tracking URL.
campaign.travel_campaign_settings.travel_account_id	official_attribute	Travel account id	Google Ads API v24 campaign	Immutable. The Travel account ID associated with the Travel campaign.
campaign.url_custom_parameters	official_attribute	Url custom parameters	Google Ads API v24 campaign	The list of mappings used to substitute custom parameter tags in a tracking_url_template , final_urls , or mobile_final_urls .
campaign.vanity_pharma.vanity_pharma_display_url_mode	official_attribute	Vanity pharma display url mode	Google Ads API v24 campaign	The display mode for vanity pharma URLs.
campaign.vanity_pharma.vanity_pharma_text	official_attribute	Vanity pharma text	Google Ads API v24 campaign	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.
campaign.video_campaign_settings.booking_details.cancellation_date_time	official_attribute	Cancellation date time	Google Ads API v24 campaign	Output only. Time when the booked inventory of this campaign will be cancelled or has been cancelled. Available for primary status NOT_ELIGIBLE if the campaign will be cancelled and for primary status reason BOOKING_CANCELLED. Format is "yyyy-MM-dd HH:mm:ss"…
campaign.video_campaign_settings.booking_details.hold_expiration_date_time	official_attribute	Hold expiration date time	Google Ads API v24 campaign	Output only. Time until which booked inventory will be held or has been held for this campaign. Available for status HELD and HOLD_EXPIRED. Format is "yyyy-MM-dd HH:mm:ss" in the customer's time zone.
campaign.video_campaign_settings.booking_details.status	official_attribute	Status	Google Ads API v24 campaign	Output only. The status of the booking.
campaign.video_campaign_settings.reservation_ad_category_self_disclosure.alcohol	official_attribute	Alcohol	Google Ads API v24 campaign	The campaign is expected to contain alcohol-related ads.
campaign.video_campaign_settings.reservation_ad_category_self_disclosure.gambling	official_attribute	Gambling	Google Ads API v24 campaign	The campaign is expected to contain gambling-related ads.
campaign.video_campaign_settings.reservation_ad_category_self_disclosure.politics	official_attribute	Politics	Google Ads API v24 campaign	The campaign is expected to contain politics-related ads.
campaign.video_campaign_settings.video_ad_format_control.format_restriction	official_attribute	Format restriction	Google Ads API v24 campaign	All contained responsive ads are expected to respect this restriction.
campaign.video_campaign_settings.video_ad_format_control.non_skippable_in_stream_restrictions.max_duration	official_attribute	Max duration	Google Ads API v24 campaign	The maximum allowed duration for non-skippable ads.
campaign.video_campaign_settings.video_ad_format_control.non_skippable_in_stream_restrictions.min_duration	official_attribute	Min duration	Google Ads API v24 campaign	The minimum allowed duration for non-skippable ads.
campaign.video_campaign_settings.video_ad_inventory_control.allow_in_feed	official_attribute	Allow in feed	Google Ads API v24 campaign	Determine if video responsive ads can be used for in-feed video ads.
campaign.video_campaign_settings.video_ad_inventory_control.allow_in_stream	official_attribute	Allow in stream	Google Ads API v24 campaign	Determine if video responsive ads can be used for in-stream video ads.
campaign.video_campaign_settings.video_ad_inventory_control.allow_non_skippable_in_stream	official_attribute	Allow non skippable in stream	Google Ads API v24 campaign	Determine if video responsive ads can be used for non-skippable in-stream ads. This is only available for campaigns that allow mixing of non-skippable with other formats (Video reach campaign with Target Frequency bidding strategy goal).
campaign.video_campaign_settings.video_ad_inventory_control.allow_shorts	official_attribute	Allow shorts	Google Ads API v24 campaign	Determine if video responsive ads can be used as shorts format.
campaign.video_campaign_settings.video_ad_sequence.minimum_duration	official_attribute	Minimum duration	Google Ads API v24 campaign	Users are eligible to repeat sequence after this period. Defaults to WEEK if not specified.
campaign.video_campaign_settings.video_ad_sequence.steps	official_attribute	Steps	Google Ads API v24 campaign	The list of sequence steps and data associated with them.
campaign.view_through_conversion_optimization_enabled	official_attribute	View through conversion optimization enabled	Google Ads API v24 campaign	Whether VTC (View-through Conversion) optimization is enabled for this campaign. Only allowed for certain Demand Gen and App Campaigns.
campaign_budget.aligned_bidding_strategy_id	official_attribute	Aligned bidding strategy id	Google Ads API v24 campaign_budget	ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campa…
campaign_budget.amount_micros	official_attribute	Amount micros	Google Ads API v24 campaign_budget	The average daily amount to be spent by the campaign. This field is used when the CampaignBudget period is set to DAILY , which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency uni…
campaign_budget.delivery_method	official_attribute	Delivery method	Google Ads API v24 campaign_budget	The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
campaign_budget.explicitly_shared	official_attribute	Explicitly shared	Google Ads API v24 campaign_budget	Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only bei…
campaign_budget.has_recommended_budget	official_attribute	Has recommended budget	Google Ads API v24 campaign_budget	Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
campaign_budget.id	official_attribute	Id	Google Ads API v24 campaign_budget	Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget amon…
campaign_budget.name	official_attribute	Name	Google Ads API v24 campaign_budget	The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached c…
campaign_budget.period	official_attribute	Period	Google Ads API v24 campaign_budget	Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
campaign_budget.recommended_budget_amount_micros	official_attribute	Recommended budget amount micros	Google Ads API v24 campaign_budget	Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.
campaign_budget.recommended_budget_estimated_change_weekly_clicks	official_attribute	Recommended budget estimated change weekly clicks	Google Ads API v24 campaign_budget	Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
campaign_budget.recommended_budget_estimated_change_weekly_cost_micros	official_attribute	Recommended budget estimated change weekly cost micros	Google Ads API v24 campaign_budget	Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.
campaign_budget.recommended_budget_estimated_change_weekly_interactions	official_attribute	Recommended budget estimated change weekly interactions	Google Ads API v24 campaign_budget	Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
campaign_budget.recommended_budget_estimated_change_weekly_views	official_attribute	Recommended budget estimated change weekly views	Google Ads API v24 campaign_budget	Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
campaign_budget.reference_count	official_attribute	Reference count	Google Ads API v24 campaign_budget	Output only. The number of campaigns actively using the budget. This field is read-only.
campaign_budget.resource_name	official_attribute	Resource name	Google Ads API v24 campaign_budget	Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}
campaign_budget.status	official_attribute	Status	Google Ads API v24 campaign_budget	Output only. The status of this campaign budget. This field is read-only.
campaign_budget.total_amount_micros	official_attribute	Total amount micros	Google Ads API v24 campaign_budget	The total amount to be spent by the campaign over its entire duration. This field is used only when the CampaignBudget period is set to CUSTOM_PERIOD . It represents the budget cap for the campaign's lifetime, rather than a daily limit. The amount is specifie…
campaign_budget.type	official_attribute	Type	Google Ads API v24 campaign_budget	Immutable. The type of the campaign budget.
ad_group.ad_rotation_mode	official_attribute	Ad rotation mode	Google Ads API v24 ad_group	The ad rotation mode of the ad group.
ad_group.ai_max_ad_group_setting.disable_search_term_matching	official_attribute	Disable search term matching	Google Ads API v24 ad_group	Disable search term matching for this adgroup when AI Max is enabled. Search term matching uses broad match, asset-based, and landing page-based technology to improve reach.
ad_group.audience_setting.use_audience_grouped	official_attribute	Use audience grouped	Google Ads API v24 ad_group	Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.
ad_group.base_ad_group	official_attribute	Base ad group	Google Ads API v24 ad_group	Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field…
ad_group.campaign	official_attribute	Campaign	Google Ads API v24 ad_group	Immutable. The campaign to which the ad group belongs.
ad_group.cpc_bid_micros	official_attribute	Cpc bid micros	Google Ads API v24 ad_group	The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.
ad_group.cpm_bid_micros	official_attribute	Cpm bid micros	Google Ads API v24 ad_group	The maximum CPM (cost-per-thousand viewable impressions) bid.
ad_group.cpv_bid_micros	official_attribute	Cpv bid micros	Google Ads API v24 ad_group	The CPV (cost-per-view) bid.
ad_group.demand_gen_ad_group_settings.channel_controls.channel_config	official_attribute	Channel config	Google Ads API v24 ad_group	Output only. Channel configuration reflecting which field in the oneof is populated.
ad_group.demand_gen_ad_group_settings.channel_controls.channel_strategy	official_attribute	Channel strategy	Google Ads API v24 ad_group	High level channel strategy.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.discover	official_attribute	Discover	Google Ads API v24 ad_group	Whether to enable ads on the Discover channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.display	official_attribute	Display	Google Ads API v24 ad_group	Whether to enable ads on the Display channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.gmail	official_attribute	Gmail	Google Ads API v24 ad_group	Whether to enable ads on the Gmail channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.maps	official_attribute	Maps	Google Ads API v24 ad_group	Whether to enable ads on the Maps channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.youtube_in_feed	official_attribute	Youtube in feed	Google Ads API v24 ad_group	Whether to enable ads on the YouTube In-Feed channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.youtube_in_stream	official_attribute	Youtube in stream	Google Ads API v24 ad_group	Whether to enable ads on the YouTube In-Stream channel.
ad_group.demand_gen_ad_group_settings.channel_controls.selected_channels.youtube_shorts	official_attribute	Youtube shorts	Google Ads API v24 ad_group	Whether to enable ads on the YouTube Shorts channel.
ad_group.display_custom_bid_dimension	official_attribute	Display custom bid dimension	Google Ads API v24 ad_group	Lets advertisers specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.
ad_group.effective_cpc_bid_micros	official_attribute	Effective cpc bid micros	Google Ads API v24 ad_group	Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
ad_group.effective_target_cpa_micros	official_attribute	Effective target cpa micros	Google Ads API v24 ad_group	Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
ad_group.effective_target_cpa_source	official_attribute	Effective target cpa source	Google Ads API v24 ad_group	Output only. Source of the effective target CPA. This field is read-only.
ad_group.effective_target_cpc	official_attribute	Effective target cpc	Google Ads API v24 ad_group	Output only. The effective target CPC (cost-per-click). This field is read-only.
ad_group.effective_target_cpc_source	official_attribute	Effective target cpc source	Google Ads API v24 ad_group	Output only. Source of the effective target CPC. This field is read-only.
ad_group.effective_target_roas	official_attribute	Effective target roas	Google Ads API v24 ad_group	Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
ad_group.effective_target_roas_source	official_attribute	Effective target roas source	Google Ads API v24 ad_group	Output only. Source of the effective target ROAS. This field is read-only.
ad_group.exclude_demographic_expansion	official_attribute	Exclude demographic expansion	Google Ads API v24 ad_group	When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
ad_group.excluded_parent_asset_field_types	official_attribute	Excluded parent asset field types	Google Ads API v24 ad_group	The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
ad_group.excluded_parent_asset_set_types	official_attribute	Excluded parent asset set types	Google Ads API v24 ad_group	The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_…
ad_group.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 ad_group	URL template for appending params to Final URL.
ad_group.fixed_cpm_micros	official_attribute	Fixed cpm micros	Google Ads API v24 ad_group	The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
ad_group.id	official_attribute	Id	Google Ads API v24 ad_group	Output only. The ID of the ad group.
ad_group.labels	official_attribute	Labels	Google Ads API v24 ad_group	Output only. The resource names of labels attached to this ad group.
ad_group.name	official_attribute	Name	Google Ads API v24 ad_group	The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (…
ad_group.optimized_targeting_enabled	official_attribute	Optimized targeting enabled	Google Ads API v24 ad_group	True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
ad_group.percent_cpc_bid_micros	official_attribute	Percent cpc bid micros	Google Ads API v24 ad_group	The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
ad_group.primary_status	official_attribute	Primary status	Google Ads API v24 ad_group	Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
ad_group.primary_status_reasons	official_attribute	Primary status reasons	Google Ads API v24 ad_group	Output only. Provides reasons for why an ad group is not serving or not serving optimally.
ad_group.resource_name	official_attribute	Resource name	Google Ads API v24 ad_group	Immutable. The resource name of the ad group. Ad group resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}
ad_group.status	official_attribute	Status	Google Ads API v24 ad_group	The status of the ad group.
ad_group.target_cpa_micros	official_attribute	Target cpa micros	Google Ads API v24 ad_group	The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this valu…
ad_group.target_cpc_micros	official_attribute	Target cpc micros	Google Ads API v24 ad_group	Average amount in micros that the advertiser is willing to pay for every ad click. Overrides the target CPC configured at the campaign level.
ad_group.target_cpm_micros	official_attribute	Target cpm micros	Google Ads API v24 ad_group	Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
ad_group.target_cpv_micros	official_attribute	Target cpv micros	Google Ads API v24 ad_group	Average amount in micros that the advertiser is willing to pay for every ad view.
ad_group.target_roas	official_attribute	Target roas	Google Ads API v24 ad_group	The target ROAS (return-on-ad-spend) for this ad group. This field lets you override the target ROAS specified in the campaign's bidding strategy, but only if the campaign is using a standard (not portfolio) TargetRoas strategy or a standard MaximizeConversio…
ad_group.targeting_setting.target_restrictions	official_attribute	Target restrictions	Google Ads API v24 ad_group	The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
ad_group.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 ad_group	The URL template for constructing a tracking URL.
ad_group.type	official_attribute	Type	Google Ads API v24 ad_group	Immutable. The type of the ad group.
ad_group.url_custom_parameters	official_attribute	Url custom parameters	Google Ads API v24 ad_group	The list of mappings used to substitute custom parameter tags in a tracking_url_template , final_urls , or mobile_final_urls .
ad_group.vertical_ads_format_setting.disable_text_ads	official_attribute	Disable text ads	Google Ads API v24 ad_group	If true, text ads will be disabled for this ad group.
ad_group.vertical_ads_format_setting.enable_booking_links	official_attribute	Enable booking links	Google Ads API v24 ad_group	If true, booking links will be enabled for this ad group.
ad_group.vertical_ads_format_setting.enable_vertical_promotion_ads	official_attribute	Enable vertical promotion ads	Google Ads API v24 ad_group	If true, vertical promotion ads will be enabled for this ad group.
ad_group.video_ad_group_settings.video_ad_sequence.step_id	official_attribute	Step id	Google Ads API v24 ad_group	The ID of this sequence step from an existing campaign.video_campaign_settings.video_ad_sequence definition. Only one Ad Group can point to a given step_id .
ad_group_ad.action_items	official_attribute	Action items	Google Ads API v24 ad_group_ad	Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Try adding a few more unique headlines or unpinning some assets.".
ad_group_ad.ad.added_by_google_ads	official_attribute	Added by google ads	Google Ads API v24 ad_group_ad	Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
ad_group_ad.ad.app_ad.app_deep_link	official_attribute	App deep link	Google Ads API v24 ad_group_ad	An app deep link asset that may be used with the ad.
ad_group_ad.ad.app_ad.app_deep_link.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this app deep link asset.
ad_group_ad.ad.app_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad.ad.app_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad.ad.app_ad.html5_media_bundles	official_attribute	Html5 media bundles	Google Ads API v24 ad_group_ad	List of media bundle assets that may be used with the ad.
ad_group_ad.ad.app_ad.html5_media_bundles.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this media bundle.
ad_group_ad.ad.app_ad.images	official_attribute	Images	Google Ads API v24 ad_group_ad	List of image assets that may be displayed with the ad.
ad_group_ad.ad.app_ad.images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.app_ad.mandatory_ad_text	official_attribute	Mandatory ad text	Google Ads API v24 ad_group_ad	Mandatory ad text.
ad_group_ad.ad.app_ad.youtube_videos	official_attribute	Youtube videos	Google Ads API v24 ad_group_ad	List of YouTube video assets that may be displayed with the ad.
ad_group_ad.ad.app_ad.youtube_videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.app_engagement_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad.ad.app_engagement_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad.ad.app_engagement_ad.images	official_attribute	Images	Google Ads API v24 ad_group_ad	List of image assets that may be displayed with the ad.
ad_group_ad.ad.app_engagement_ad.images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.app_engagement_ad.videos	official_attribute	Videos	Google Ads API v24 ad_group_ad	List of video assets that may be displayed with the ad.
ad_group_ad.ad.app_engagement_ad.videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.app_pre_registration_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad.ad.app_pre_registration_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad.ad.app_pre_registration_ad.images	official_attribute	Images	Google Ads API v24 ad_group_ad	List of image asset IDs whose images may be displayed with the ad.
ad_group_ad.ad.app_pre_registration_ad.images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.app_pre_registration_ad.youtube_videos	official_attribute	Youtube videos	Google Ads API v24 ad_group_ad	List of YouTube video asset IDs whose videos may be displayed with the ad.
ad_group_ad.ad.app_pre_registration_ad.youtube_videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.demand_gen_carousel_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	Required. The Advertiser/brand name.
ad_group_ad.ad.demand_gen_carousel_ad.call_to_action_text	official_attribute	Call to action text	Google Ads API v24 ad_group_ad	Call to action text.
ad_group_ad.ad.demand_gen_carousel_ad.carousel_cards	official_attribute	Carousel cards	Google Ads API v24 ad_group_ad	Required. Carousel cards that will display with the ad. Min 2 max 10.
ad_group_ad.ad.demand_gen_carousel_ad.carousel_cards.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this discovery carousel card.
ad_group_ad.ad.demand_gen_carousel_ad.description	official_attribute	Description	Google Ads API v24 ad_group_ad	Required. The descriptive text of the ad.
ad_group_ad.ad.demand_gen_carousel_ad.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	Required. Headline of the ad.
ad_group_ad.ad.demand_gen_carousel_ad.logo_image	official_attribute	Logo image	Google Ads API v24 ad_group_ad	Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
ad_group_ad.ad.demand_gen_carousel_ad.logo_image.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	The Advertiser/brand name. Maximum display width is 25. Required.
ad_group_ad.ad.demand_gen_multi_asset_ad.call_to_action_text	official_attribute	Call to action text	Google Ads API v24 ad_group_ad	Call to action text.
ad_group_ad.ad.demand_gen_multi_asset_ad.classic_display_images	official_attribute	Classic display images	Google Ads API v24 ad_group_ad	Classic display image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. At most 20 classic display images can be specified per ad.
ad_group_ad.ad.demand_gen_multi_asset_ad.classic_display_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
ad_group_ad.ad.demand_gen_multi_asset_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
ad_group_ad.ad.demand_gen_multi_asset_ad.logo_images	official_attribute	Logo images	Google Ads API v24 ad_group_ad	Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). At least 1 and max 5 logo images can be specified.
ad_group_ad.ad.demand_gen_multi_asset_ad.logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.marketing_images	official_attribute	Marketing images	Google Ads API v24 ad_group_ad	Marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). Required if square_marketing_images is not present. Combined with square_marketing_images , portrait…
ad_group_ad.ad.demand_gen_multi_asset_ad.marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.portrait_marketing_images	official_attribute	Portrait marketing images	Google Ads API v24 ad_group_ad	Portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketing_images , square_marketing_images , and tall_portrait_marketing_images…
ad_group_ad.ad.demand_gen_multi_asset_ad.portrait_marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.square_marketing_images	official_attribute	Square marketing images	Google Ads API v24 ad_group_ad	Square marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). Required if marketing_images is not present. Combined with marketing_images , portrait_marketing…
ad_group_ad.ad.demand_gen_multi_asset_ad.square_marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_multi_asset_ad.tall_portrait_marketing_images	official_attribute	Tall portrait marketing images	Google Ads API v24 ad_group_ad	Tall portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x1067 and the aspect ratio must be 9:16 (+-1%). Combined with marketing_images , square_marketing_images , and portrait_marketing_image…
ad_group_ad.ad.demand_gen_multi_asset_ad.tall_portrait_marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_product_ad.breadcrumb1	official_attribute	Breadcrumb1	Google Ads API v24 ad_group_ad	First part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.demand_gen_product_ad.breadcrumb2	official_attribute	Breadcrumb2	Google Ads API v24 ad_group_ad	Second part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.demand_gen_product_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	Required. The advertiser/brand name.
ad_group_ad.ad.demand_gen_product_ad.call_to_action	official_attribute	Call to action	Google Ads API v24 ad_group_ad	Asset of type CallToActionAsset used for the "Call To Action" button.
ad_group_ad.ad.demand_gen_product_ad.call_to_action.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this call to action asset.
ad_group_ad.ad.demand_gen_product_ad.description	official_attribute	Description	Google Ads API v24 ad_group_ad	Required. Text asset used for the description.
ad_group_ad.ad.demand_gen_product_ad.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	Required. Text asset used for the short headline.
ad_group_ad.ad.demand_gen_product_ad.logo_image	official_attribute	Logo image	Google Ads API v24 ad_group_ad	Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
ad_group_ad.ad.demand_gen_product_ad.logo_image.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_video_responsive_ad.breadcrumb1	official_attribute	Breadcrumb1	Google Ads API v24 ad_group_ad	First part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.demand_gen_video_responsive_ad.breadcrumb2	official_attribute	Breadcrumb2	Google Ads API v24 ad_group_ad	Second part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.demand_gen_video_responsive_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	Required. The advertiser/brand name.
ad_group_ad.ad.demand_gen_video_responsive_ad.call_to_actions	official_attribute	Call to actions	Google Ads API v24 ad_group_ad	Assets of type CallToActionAsset used for the "Call To Action" button.
ad_group_ad.ad.demand_gen_video_responsive_ad.call_to_actions.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this call to action asset.
ad_group_ad.ad.demand_gen_video_responsive_ad.companion_banners	official_attribute	Companion banners	Google Ads API v24 ad_group_ad	List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
ad_group_ad.ad.demand_gen_video_responsive_ad.companion_banners.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_video_responsive_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets used for the description.
ad_group_ad.ad.demand_gen_video_responsive_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets used for the short headline.
ad_group_ad.ad.demand_gen_video_responsive_ad.logo_images	official_attribute	Logo images	Google Ads API v24 ad_group_ad	Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
ad_group_ad.ad.demand_gen_video_responsive_ad.logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.demand_gen_video_responsive_ad.long_headlines	official_attribute	Long headlines	Google Ads API v24 ad_group_ad	List of text assets used for the long headline.
ad_group_ad.ad.demand_gen_video_responsive_ad.videos	official_attribute	Videos	Google Ads API v24 ad_group_ad	Required. List of YouTube video assets used for the ad.
ad_group_ad.ad.demand_gen_video_responsive_ad.videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.device_preference	official_attribute	Device preference	Google Ads API v24 ad_group_ad	The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, for examp…
ad_group_ad.ad.display_upload_ad.display_upload_product_type	official_attribute	Display upload product type	Google Ads API v24 ad_group_ad	The product type of this ad. See comments on the enum for details.
ad_group_ad.ad.display_upload_ad.media_bundle	official_attribute	Media bundle	Google Ads API v24 ad_group_ad	A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created…
ad_group_ad.ad.display_upload_ad.media_bundle.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this media bundle.
ad_group_ad.ad.display_url	official_attribute	Display url	Google Ads API v24 ad_group_ad	The URL that appears in the ad description for some ad formats.
ad_group_ad.ad.expanded_dynamic_search_ad.description	official_attribute	Description	Google Ads API v24 ad_group_ad	The description of the ad.
ad_group_ad.ad.expanded_dynamic_search_ad.description2	official_attribute	Description2	Google Ads API v24 ad_group_ad	The second description of the ad.
ad_group_ad.ad.expanded_text_ad.description	official_attribute	Description	Google Ads API v24 ad_group_ad	The description of the ad.
ad_group_ad.ad.expanded_text_ad.description2	official_attribute	Description2	Google Ads API v24 ad_group_ad	The second description of the ad.
ad_group_ad.ad.expanded_text_ad.headline_part1	official_attribute	Headline part1	Google Ads API v24 ad_group_ad	The first part of the ad's headline.
ad_group_ad.ad.expanded_text_ad.headline_part2	official_attribute	Headline part2	Google Ads API v24 ad_group_ad	The second part of the ad's headline.
ad_group_ad.ad.expanded_text_ad.headline_part3	official_attribute	Headline part3	Google Ads API v24 ad_group_ad	The third part of the ad's headline.
ad_group_ad.ad.expanded_text_ad.path1	official_attribute	Path1	Google Ads API v24 ad_group_ad	The text that can appear alongside the ad's displayed URL.
ad_group_ad.ad.expanded_text_ad.path2	official_attribute	Path2	Google Ads API v24 ad_group_ad	Additional text that can appear alongside the ad's displayed URL.
ad_group_ad.ad.final_app_urls	official_attribute	Final app urls	Google Ads API v24 ad_group_ad	A list of final app URLs that will be used on mobile if the user has the specific app installed.
ad_group_ad.ad.final_mobile_urls	official_attribute	Final mobile urls	Google Ads API v24 ad_group_ad	The list of possible final mobile URLs after all cross-domain redirects for the ad.
ad_group_ad.ad.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 ad_group_ad	The suffix to use when constructing a final URL.
ad_group_ad.ad.final_urls	official_attribute	Final urls	Google Ads API v24 ad_group_ad	The list of possible final URLs after all cross-domain redirects for the ad.
ad_group_ad.ad.hotel_ad	official_attribute	Hotel ad	Google Ads API v24 ad_group_ad	Details pertaining to a hotel ad.
ad_group_ad.ad.id	official_attribute	Id	Google Ads API v24 ad_group_ad	Output only. The ID of the ad.
ad_group_ad.ad.image_ad.image_asset.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.image_ad.image_url	official_attribute	Image url	Google Ads API v24 ad_group_ad	URL of the full size image.
ad_group_ad.ad.image_ad.mime_type	official_attribute	Mime type	Google Ads API v24 ad_group_ad	The mime type of the image.
ad_group_ad.ad.image_ad.name	official_attribute	Name	Google Ads API v24 ad_group_ad	The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.
ad_group_ad.ad.image_ad.pixel_height	official_attribute	Pixel height	Google Ads API v24 ad_group_ad	Height in pixels of the full size image.
ad_group_ad.ad.image_ad.pixel_width	official_attribute	Pixel width	Google Ads API v24 ad_group_ad	Width in pixels of the full size image.
ad_group_ad.ad.image_ad.preview_image_url	official_attribute	Preview image url	Google Ads API v24 ad_group_ad	URL of the preview size image.
ad_group_ad.ad.image_ad.preview_pixel_height	official_attribute	Preview pixel height	Google Ads API v24 ad_group_ad	Height in pixels of the preview size image.
ad_group_ad.ad.image_ad.preview_pixel_width	official_attribute	Preview pixel width	Google Ads API v24 ad_group_ad	Width in pixels of the preview size image.
ad_group_ad.ad.legacy_app_install_ad	official_attribute	Legacy app install ad	Google Ads API v24 ad_group_ad	Immutable. Details pertaining to a legacy app install ad.
ad_group_ad.ad.legacy_responsive_display_ad.accent_color	official_attribute	Accent color	Google Ads API v24 ad_group_ad	The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
ad_group_ad.ad.legacy_responsive_display_ad.allow_flexible_color	official_attribute	Allow flexible color	Google Ads API v24 ad_group_ad	Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true . Must be true if main_color and accent_…
ad_group_ad.ad.legacy_responsive_display_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	The business name in the ad.
ad_group_ad.ad.legacy_responsive_display_ad.call_to_action_text	official_attribute	Call to action text	Google Ads API v24 ad_group_ad	The call-to-action text for the ad.
ad_group_ad.ad.legacy_responsive_display_ad.description	official_attribute	Description	Google Ads API v24 ad_group_ad	The description of the ad.
ad_group_ad.ad.legacy_responsive_display_ad.format_setting	official_attribute	Format setting	Google Ads API v24 ad_group_ad	Specifies which format the ad will be served in. Default is ALL_FORMATS.
ad_group_ad.ad.legacy_responsive_display_ad.logo_image	official_attribute	Logo image	Google Ads API v24 ad_group_ad	The MediaFile resource name of the logo image used in the ad.
ad_group_ad.ad.legacy_responsive_display_ad.long_headline	official_attribute	Long headline	Google Ads API v24 ad_group_ad	The long version of the ad's headline.
ad_group_ad.ad.legacy_responsive_display_ad.main_color	official_attribute	Main color	Google Ads API v24 ad_group_ad	The main color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
ad_group_ad.ad.legacy_responsive_display_ad.marketing_image	official_attribute	Marketing image	Google Ads API v24 ad_group_ad	The MediaFile resource name of the marketing image used in the ad.
ad_group_ad.ad.legacy_responsive_display_ad.price_prefix	official_attribute	Price prefix	Google Ads API v24 ad_group_ad	Prefix before price. For example, 'as low as'.
ad_group_ad.ad.legacy_responsive_display_ad.promo_text	official_attribute	Promo text	Google Ads API v24 ad_group_ad	Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_group_ad.ad.legacy_responsive_display_ad.short_headline	official_attribute	Short headline	Google Ads API v24 ad_group_ad	The short version of the ad's headline.
ad_group_ad.ad.legacy_responsive_display_ad.square_logo_image	official_attribute	Square logo image	Google Ads API v24 ad_group_ad	The MediaFile resource name of the square logo image used in the ad.
ad_group_ad.ad.legacy_responsive_display_ad.square_marketing_image	official_attribute	Square marketing image	Google Ads API v24 ad_group_ad	The MediaFile resource name of the square marketing image used in the ad.
ad_group_ad.ad.local_ad.call_to_actions	official_attribute	Call to actions	Google Ads API v24 ad_group_ad	List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified.
ad_group_ad.ad.local_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.
ad_group_ad.ad.local_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.
ad_group_ad.ad.local_ad.logo_images	official_attribute	Logo images	Google Ads API v24 ad_group_ad	List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.
ad_group_ad.ad.local_ad.logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.local_ad.marketing_images	official_attribute	Marketing images	Google Ads API v24 ad_group_ad	List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.
ad_group_ad.ad.local_ad.marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.local_ad.path1	official_attribute	Path1	Google Ads API v24 ad_group_ad	First part of optional text that can be appended to the URL in the ad.
ad_group_ad.ad.local_ad.path2	official_attribute	Path2	Google Ads API v24 ad_group_ad	Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set.
ad_group_ad.ad.local_ad.videos	official_attribute	Videos	Google Ads API v24 ad_group_ad	List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.
ad_group_ad.ad.local_ad.videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.name	official_attribute	Name	Google Ads API v24 ad_group_ad	Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, LegacyAppInstallAd, ShoppingComparisonLis…
ad_group_ad.ad.resource_name	official_attribute	Resource name	Google Ads API v24 ad_group_ad	Immutable. The resource name of the ad. Ad resource names have the form: customers/{customer_id}/ads/{ad_id}
ad_group_ad.ad.responsive_display_ad.accent_color	official_attribute	Accent color	Google Ads API v24 ad_group_ad	The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
ad_group_ad.ad.responsive_display_ad.allow_flexible_color	official_attribute	Allow flexible color	Google Ads API v24 ad_group_ad	Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true . Must be true if main_color and accent_…
ad_group_ad.ad.responsive_display_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	The advertiser/brand name. Maximum display width is 25.
ad_group_ad.ad.responsive_display_ad.call_to_action_text	official_attribute	Call to action text	Google Ads API v24 ad_group_ad	The call-to-action text for the ad. Maximum display width is 30.
ad_group_ad.ad.responsive_display_ad.control_spec.enable_asset_enhancements	official_attribute	Enable asset enhancements	Google Ads API v24 ad_group_ad	Whether the advertiser has opted into the asset enhancements feature.
ad_group_ad.ad.responsive_display_ad.control_spec.enable_autogen_video	official_attribute	Enable autogen video	Google Ads API v24 ad_group_ad	Whether the advertiser has opted into auto-gen video feature.
ad_group_ad.ad.responsive_display_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
ad_group_ad.ad.responsive_display_ad.format_setting	official_attribute	Format setting	Google Ads API v24 ad_group_ad	Specifies which format the ad will be served in. Default is ALL_FORMATS.
ad_group_ad.ad.responsive_display_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
ad_group_ad.ad.responsive_display_ad.logo_images	official_attribute	Logo images	Google Ads API v24 ad_group_ad	Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images , the maximum is 5.
ad_group_ad.ad.responsive_display_ad.logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.responsive_display_ad.long_headline	official_attribute	Long headline	Google Ads API v24 ad_group_ad	A required long format headline. The maximum length is 90 characters.
ad_group_ad.ad.responsive_display_ad.main_color	official_attribute	Main color	Google Ads API v24 ad_group_ad	The main color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
ad_group_ad.ad.responsive_display_ad.marketing_images	official_attribute	Marketing images	Google Ads API v24 ad_group_ad	Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images , the maximum is 15.
ad_group_ad.ad.responsive_display_ad.marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.responsive_display_ad.price_prefix	official_attribute	Price prefix	Google Ads API v24 ad_group_ad	Prefix before price. For example, 'as low as'.
ad_group_ad.ad.responsive_display_ad.promo_text	official_attribute	Promo text	Google Ads API v24 ad_group_ad	Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_group_ad.ad.responsive_display_ad.square_logo_images	official_attribute	Square logo images	Google Ads API v24 ad_group_ad	Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with logo_images , the maximum is 5.
ad_group_ad.ad.responsive_display_ad.square_logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.responsive_display_ad.square_marketing_images	official_attribute	Square marketing images	Google Ads API v24 ad_group_ad	Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images , the maximum is 15.
ad_group_ad.ad.responsive_display_ad.square_marketing_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.responsive_display_ad.youtube_videos	official_attribute	Youtube videos	Google Ads API v24 ad_group_ad	Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
ad_group_ad.ad.responsive_display_ad.youtube_videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.responsive_search_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad.ad.responsive_search_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad.ad.responsive_search_ad.path1	official_attribute	Path1	Google Ads API v24 ad_group_ad	First part of text that can be appended to the URL in the ad.
ad_group_ad.ad.responsive_search_ad.path2	official_attribute	Path2	Google Ads API v24 ad_group_ad	Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set.
ad_group_ad.ad.shopping_comparison_listing_ad.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.
ad_group_ad.ad.shopping_product_ad	official_attribute	Shopping product ad	Google Ads API v24 ad_group_ad	Details pertaining to a Shopping product ad.
ad_group_ad.ad.shopping_smart_ad	official_attribute	Shopping smart ad	Google Ads API v24 ad_group_ad	Details pertaining to a Smart Shopping ad.
ad_group_ad.ad.smart_campaign_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
ad_group_ad.ad.smart_campaign_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
ad_group_ad.ad.synthetic_content_info.advertiser_attestation.source	official_attribute	Source	Google Ads API v24 ad_group_ad	The source of the synthetic content attestation.
ad_group_ad.ad.synthetic_content_info.advertiser_attestation.status	official_attribute	Status	Google Ads API v24 ad_group_ad	Indicates whether the content is considered synthetic by this source.
ad_group_ad.ad.synthetic_content_info.system_attestation.source	official_attribute	Source	Google Ads API v24 ad_group_ad	The source of the synthetic content attestation.
ad_group_ad.ad.synthetic_content_info.system_attestation.status	official_attribute	Status	Google Ads API v24 ad_group_ad	Indicates whether the content is considered synthetic by this source.
ad_group_ad.ad.system_managed_resource_source	official_attribute	System managed resource source	Google Ads API v24 ad_group_ad	Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.
ad_group_ad.ad.text_ad.description1	official_attribute	Description1	Google Ads API v24 ad_group_ad	The first line of the ad's description.
ad_group_ad.ad.text_ad.description2	official_attribute	Description2	Google Ads API v24 ad_group_ad	The second line of the ad's description.
ad_group_ad.ad.text_ad.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	The headline of the ad.
ad_group_ad.ad.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 ad_group_ad	The URL template for constructing a tracking URL.
ad_group_ad.ad.travel_ad	official_attribute	Travel ad	Google Ads API v24 ad_group_ad	Details pertaining to a travel ad.
ad_group_ad.ad.type	official_attribute	Type	Google Ads API v24 ad_group_ad	Output only. The type of ad.
ad_group_ad.ad.url_collections	official_attribute	Url collections	Google Ads API v24 ad_group_ad	Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
ad_group_ad.ad.url_custom_parameters	official_attribute	Url custom parameters	Google Ads API v24 ad_group_ad	The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template , final_urls , or mobile_final_urls . For mutates, use url custom parameter operations.
ad_group_ad.ad.video_ad.audio	official_attribute	Audio	Google Ads API v24 ad_group_ad	YouTube Audio ad format.
ad_group_ad.ad.video_ad.bumper.action_button_label	official_attribute	Action button label	Google Ads API v24 ad_group_ad	Label on the "Call To Action" button taking the user to the video ad's final URL.
ad_group_ad.ad.video_ad.bumper.action_headline	official_attribute	Action headline	Google Ads API v24 ad_group_ad	Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
ad_group_ad.ad.video_ad.bumper.companion_banner.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.video_ad.in_feed.description1	official_attribute	Description1	Google Ads API v24 ad_group_ad	First text line for the ad.
ad_group_ad.ad.video_ad.in_feed.description2	official_attribute	Description2	Google Ads API v24 ad_group_ad	Second text line for the ad.
ad_group_ad.ad.video_ad.in_feed.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	The headline of the ad.
ad_group_ad.ad.video_ad.in_feed.thumbnail	official_attribute	Thumbnail	Google Ads API v24 ad_group_ad	Video thumbnail image to use.
ad_group_ad.ad.video_ad.in_stream.action_button_label	official_attribute	Action button label	Google Ads API v24 ad_group_ad	Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.
ad_group_ad.ad.video_ad.in_stream.action_headline	official_attribute	Action headline	Google Ads API v24 ad_group_ad	Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
ad_group_ad.ad.video_ad.in_stream.companion_banner.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.video_ad.non_skippable.action_button_label	official_attribute	Action button label	Google Ads API v24 ad_group_ad	Label on the "Call To Action" button taking the user to the video ad's final URL.
ad_group_ad.ad.video_ad.non_skippable.action_headline	official_attribute	Action headline	Google Ads API v24 ad_group_ad	Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button.
ad_group_ad.ad.video_ad.non_skippable.companion_banner.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.video_ad.out_stream.description	official_attribute	Description	Google Ads API v24 ad_group_ad	The description line.
ad_group_ad.ad.video_ad.out_stream.headline	official_attribute	Headline	Google Ads API v24 ad_group_ad	The headline of the ad.
ad_group_ad.ad.video_ad.video.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad.video_responsive_ad.breadcrumb1	official_attribute	Breadcrumb1	Google Ads API v24 ad_group_ad	First part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.video_responsive_ad.breadcrumb2	official_attribute	Breadcrumb2	Google Ads API v24 ad_group_ad	Second part of text that appears in the ad with the displayed URL.
ad_group_ad.ad.video_responsive_ad.business_name	official_attribute	Business name	Google Ads API v24 ad_group_ad	Required. Advertiser/brand name. Maximum display width is 25 characters.
ad_group_ad.ad.video_responsive_ad.call_to_actions	official_attribute	Call to actions	Google Ads API v24 ad_group_ad	List of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.
ad_group_ad.ad.video_responsive_ad.companion_banners	official_attribute	Companion banners	Google Ads API v24 ad_group_ad	List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
ad_group_ad.ad.video_responsive_ad.companion_banners.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.video_responsive_ad.descriptions	official_attribute	Descriptions	Google Ads API v24 ad_group_ad	List of text assets used for the description. Currently, only a single value for the description is supported.
ad_group_ad.ad.video_responsive_ad.headlines	official_attribute	Headlines	Google Ads API v24 ad_group_ad	List of text assets used for the short headline. Currently, only a single value for the short headline is supported.
ad_group_ad.ad.video_responsive_ad.logo_images	official_attribute	Logo images	Google Ads API v24 ad_group_ad	Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
ad_group_ad.ad.video_responsive_ad.logo_images.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this image.
ad_group_ad.ad.video_responsive_ad.long_headlines	official_attribute	Long headlines	Google Ads API v24 ad_group_ad	List of text assets used for the long headline. Currently, only a single value for the long headline is supported.
ad_group_ad.ad.video_responsive_ad.videos	official_attribute	Videos	Google Ads API v24 ad_group_ad	Required. List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
ad_group_ad.ad.video_responsive_ad.videos.asset	official_attribute	Asset	Google Ads API v24 ad_group_ad	The Asset resource name of this video.
ad_group_ad.ad_group	official_attribute	Ad group	Google Ads API v24 ad_group_ad	Immutable. The ad group to which the ad belongs.
ad_group_ad.ad_group_ad_asset_automation_settings	official_attribute	Ad group ad asset automation settings	Google Ads API v24 ad_group_ad	Settings that control the types of asset automation. See the AssetAutomationTypeEnum documentation for the default opt in/out behavior of each type.
ad_group_ad.ad_strength	official_attribute	Ad strength	Google Ads API v24 ad_group_ad	Output only. Overall ad strength for this ad group ad.
ad_group_ad.end_date_time	official_attribute	End date time	Google Ads API v24 ad_group_ad	The last day and time when ad group ad serves. This is added on top of the campaign's end date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Only sup…
ad_group_ad.labels	official_attribute	Labels	Google Ads API v24 ad_group_ad	Output only. The resource names of labels attached to this ad group ad.
ad_group_ad.policy_summary.approval_status	official_attribute	Approval status	Google Ads API v24 ad_group_ad	Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.
ad_group_ad.policy_summary.policy_topic_entries	official_attribute	Policy topic entries	Google Ads API v24 ad_group_ad	Output only. The list of policy findings for this ad.
ad_group_ad.policy_summary.review_status	official_attribute	Review status	Google Ads API v24 ad_group_ad	Output only. Where in the review process this ad is.
ad_group_ad.primary_status	official_attribute	Primary status	Google Ads API v24 ad_group_ad	Output only. Provides aggregated view into why an ad group ad is not serving or not serving optimally.
ad_group_ad.primary_status_reasons	official_attribute	Primary status reasons	Google Ads API v24 ad_group_ad	Output only. Provides reasons for why an ad group ad is not serving or not serving optimally.
ad_group_ad.resource_name	official_attribute	Resource name	Google Ads API v24 ad_group_ad	Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}
ad_group_ad.start_date_time	official_attribute	Start date time	Google Ads API v24 ad_group_ad	The date and time when ad group ad starts serving. This is added on top of the campaign's start date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. On…
ad_group_ad.status	official_attribute	Status	Google Ads API v24 ad_group_ad	The status of the ad.
ad_group_criterion.ad_group	official_attribute	Ad group	Google Ads API v24 ad_group_criterion	Immutable. The ad group to which the criterion belongs.
ad_group_criterion.age_range.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the age range.
ad_group_criterion.app_payment_model.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the app payment model.
ad_group_criterion.approval_status	official_attribute	Approval status	Google Ads API v24 ad_group_criterion	Output only. Approval status of the criterion.
ad_group_criterion.audience.audience	official_attribute	Audience	Google Ads API v24 ad_group_criterion	The Audience resource name.
ad_group_criterion.bid_modifier	official_attribute	Bid modifier	Google Ads API v24 ad_group_criterion	The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
ad_group_criterion.brand_list.shared_set	official_attribute	Shared set	Google Ads API v24 ad_group_criterion	Shared set resource name of the brand list.
ad_group_criterion.combined_audience.combined_audience	official_attribute	Combined audience	Google Ads API v24 ad_group_criterion	The CombinedAudience resource name.
ad_group_criterion.cpc_bid_micros	official_attribute	Cpc bid micros	Google Ads API v24 ad_group_criterion	The CPC (cost-per-click) bid.
ad_group_criterion.cpm_bid_micros	official_attribute	Cpm bid micros	Google Ads API v24 ad_group_criterion	The CPM (cost-per-thousand viewable impressions) bid.
ad_group_criterion.cpv_bid_micros	official_attribute	Cpv bid micros	Google Ads API v24 ad_group_criterion	The CPV (cost-per-view) bid.
ad_group_criterion.criterion_id	official_attribute	Criterion id	Google Ads API v24 ad_group_criterion	Output only. The ID of the criterion. This field is ignored for mutates.
ad_group_criterion.custom_affinity.custom_affinity	official_attribute	Custom affinity	Google Ads API v24 ad_group_criterion	The CustomInterest resource name.
ad_group_criterion.custom_audience.custom_audience	official_attribute	Custom audience	Google Ads API v24 ad_group_criterion	The CustomAudience resource name.
ad_group_criterion.custom_intent.custom_intent	official_attribute	Custom intent	Google Ads API v24 ad_group_criterion	The CustomInterest resource name.
ad_group_criterion.disapproval_reasons	official_attribute	Disapproval reasons	Google Ads API v24 ad_group_criterion	Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
ad_group_criterion.display_name	official_attribute	Display name	Google Ads API v24 ad_group_criterion	Output only. The display name of the criterion. This field is ignored for mutates.
ad_group_criterion.effective_cpc_bid_micros	official_attribute	Effective cpc bid micros	Google Ads API v24 ad_group_criterion	Output only. The effective CPC (cost-per-click) bid.
ad_group_criterion.effective_cpc_bid_source	official_attribute	Effective cpc bid source	Google Ads API v24 ad_group_criterion	Output only. Source of the effective CPC bid.
ad_group_criterion.effective_cpm_bid_micros	official_attribute	Effective cpm bid micros	Google Ads API v24 ad_group_criterion	Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
ad_group_criterion.effective_cpm_bid_source	official_attribute	Effective cpm bid source	Google Ads API v24 ad_group_criterion	Output only. Source of the effective CPM bid.
ad_group_criterion.effective_cpv_bid_micros	official_attribute	Effective cpv bid micros	Google Ads API v24 ad_group_criterion	Output only. The effective CPV (cost-per-view) bid.
ad_group_criterion.effective_cpv_bid_source	official_attribute	Effective cpv bid source	Google Ads API v24 ad_group_criterion	Output only. Source of the effective CPV bid.
ad_group_criterion.effective_percent_cpc_bid_micros	official_attribute	Effective percent cpc bid micros	Google Ads API v24 ad_group_criterion	Output only. The effective Percent CPC bid amount.
ad_group_criterion.effective_percent_cpc_bid_source	official_attribute	Effective percent cpc bid source	Google Ads API v24 ad_group_criterion	Output only. Source of the effective Percent CPC bid.
ad_group_criterion.extended_demographic.extended_demographic_id	official_attribute	Extended demographic id	Google Ads API v24 ad_group_criterion	Taxonomy id of the extended demographic group.
ad_group_criterion.final_mobile_urls	official_attribute	Final mobile urls	Google Ads API v24 ad_group_criterion	The list of possible final mobile URLs after all cross-domain redirects.
ad_group_criterion.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 ad_group_criterion	URL template for appending params to final URL.
ad_group_criterion.final_urls	official_attribute	Final urls	Google Ads API v24 ad_group_criterion	The list of possible final URLs after all cross-domain redirects for the ad.
ad_group_criterion.gender.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the gender.
ad_group_criterion.income_range.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the income range.
ad_group_criterion.keyword.match_type	official_attribute	Match type	Google Ads API v24 ad_group_criterion	The match type of the keyword.
ad_group_criterion.keyword.text	official_attribute	Text	Google Ads API v24 ad_group_criterion	The text of the keyword (at most 80 characters and 10 words).
ad_group_criterion.labels	official_attribute	Labels	Google Ads API v24 ad_group_criterion	Output only. The resource names of labels attached to this ad group criterion.
ad_group_criterion.language.language_constant	official_attribute	Language constant	Google Ads API v24 ad_group_criterion	The language constant resource name.
ad_group_criterion.life_event.life_event_id	official_attribute	Life event id	Google Ads API v24 ad_group_criterion	Taxonomy id of the life event.
ad_group_criterion.listing_group.case_value.activity_city.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the activity city. The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.activity_country.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the activity country. The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.activity_id.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the activity ID.
ad_group_criterion.listing_group.case_value.activity_rating.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	Long value of the activity rating.
ad_group_criterion.listing_group.case_value.activity_state.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the activity state. The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.hotel_city.city_criterion	official_attribute	City criterion	Google Ads API v24 ad_group_criterion	The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.hotel_class.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	Long value of the hotel class.
ad_group_criterion.listing_group.case_value.hotel_country_region.country_region_criterion	official_attribute	Country region criterion	Google Ads API v24 ad_group_criterion	The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.hotel_id.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the hotel ID.
ad_group_criterion.listing_group.case_value.hotel_state.state_criterion	official_attribute	State criterion	Google Ads API v24 ad_group_criterion	The Geo Target Constant resource name.
ad_group_criterion.listing_group.case_value.product_brand.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the product brand.
ad_group_criterion.listing_group.case_value.product_category.category_id	official_attribute	Category id	Google Ads API v24 ad_group_criterion	ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
ad_group_criterion.listing_group.case_value.product_category.level	official_attribute	Level	Google Ads API v24 ad_group_criterion	Level of the product category.
ad_group_criterion.listing_group.case_value.product_channel.channel	official_attribute	Channel	Google Ads API v24 ad_group_criterion	Value of the locality.
ad_group_criterion.listing_group.case_value.product_channel_exclusivity.channel_exclusivity	official_attribute	Channel exclusivity	Google Ads API v24 ad_group_criterion	Value of the availability.
ad_group_criterion.listing_group.case_value.product_condition.condition	official_attribute	Condition	Google Ads API v24 ad_group_criterion	Value of the condition.
ad_group_criterion.listing_group.case_value.product_custom_attribute.index	official_attribute	Index	Google Ads API v24 ad_group_criterion	Indicates the index of the custom attribute.
ad_group_criterion.listing_group.case_value.product_custom_attribute.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	String value of the product custom attribute.
ad_group_criterion.listing_group.case_value.product_item_id.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	Value of the id.
ad_group_criterion.listing_group.case_value.product_type.level	official_attribute	Level	Google Ads API v24 ad_group_criterion	Level of the type.
ad_group_criterion.listing_group.case_value.product_type.value	official_attribute	Value	Google Ads API v24 ad_group_criterion	Value of the type.
ad_group_criterion.listing_group.parent_ad_group_criterion	official_attribute	Parent ad group criterion	Google Ads API v24 ad_group_criterion	Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
ad_group_criterion.listing_group.path	official_attribute	Path	Google Ads API v24 ad_group_criterion	The path of dimensions defining this listing group.
ad_group_criterion.listing_group.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the listing group.
ad_group_criterion.location.geo_target_constant	official_attribute	Geo target constant	Google Ads API v24 ad_group_criterion	The geo target constant resource name.
ad_group_criterion.mobile_app_category.mobile_app_category_constant	official_attribute	Mobile app category constant	Google Ads API v24 ad_group_criterion	The mobile app category constant resource name.
ad_group_criterion.mobile_application.app_id	official_attribute	App id	Google Ads API v24 ad_group_criterion	A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application ident…
ad_group_criterion.mobile_application.name	official_attribute	Name	Google Ads API v24 ad_group_criterion	Name of this mobile application.
ad_group_criterion.negative	official_attribute	Negative	Google Ads API v24 ad_group_criterion	Immutable. Whether to target ( false ) or exclude ( true ) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
ad_group_criterion.parental_status.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Type of the parental status.
ad_group_criterion.percent_cpc_bid_micros	official_attribute	Percent cpc bid micros	Google Ads API v24 ad_group_criterion	The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
ad_group_criterion.placement.url	official_attribute	Url	Google Ads API v24 ad_group_criterion	URL of the placement. For example, "http://www.domain.com".
ad_group_criterion.position_estimates.estimated_add_clicks_at_first_position_cpc	official_attribute	Estimated add clicks at first position cpc	Google Ads API v24 ad_group_criterion	Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
ad_group_criterion.position_estimates.estimated_add_cost_at_first_position_cpc	official_attribute	Estimated add cost at first position cpc	Google Ads API v24 ad_group_criterion	Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
ad_group_criterion.position_estimates.first_page_cpc_micros	official_attribute	First page cpc micros	Google Ads API v24 ad_group_criterion	Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
ad_group_criterion.position_estimates.first_position_cpc_micros	official_attribute	First position cpc micros	Google Ads API v24 ad_group_criterion	Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
ad_group_criterion.position_estimates.top_of_page_cpc_micros	official_attribute	Top of page cpc micros	Google Ads API v24 ad_group_criterion	Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
ad_group_criterion.primary_status	official_attribute	Primary status	Google Ads API v24 ad_group_criterion	Output only. The primary status for the ad group criterion.
ad_group_criterion.primary_status_reasons	official_attribute	Primary status reasons	Google Ads API v24 ad_group_criterion	Output only. The primary status reasons for the ad group criterion.
ad_group_criterion.quality_info.creative_quality_score	official_attribute	Creative quality score	Google Ads API v24 ad_group_criterion	Output only. The performance of the ad compared to other advertisers.
ad_group_criterion.quality_info.post_click_quality_score	official_attribute	Post click quality score	Google Ads API v24 ad_group_criterion	Output only. The quality score of the landing page.
ad_group_criterion.quality_info.quality_score	official_attribute	Quality score	Google Ads API v24 ad_group_criterion	Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
ad_group_criterion.quality_info.search_predicted_ctr	official_attribute	Search predicted ctr	Google Ads API v24 ad_group_criterion	Output only. The click-through rate compared to that of other advertisers.
ad_group_criterion.resource_name	official_attribute	Resource name	Google Ads API v24 ad_group_criterion	Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}
ad_group_criterion.retail_filter_bundle.shared_set	official_attribute	Shared set	Google Ads API v24 ad_group_criterion	The resource name of the shared set that contains the retail filter. This field is required.
ad_group_criterion.status	official_attribute	Status	Google Ads API v24 ad_group_criterion	The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the A…
ad_group_criterion.system_serving_status	official_attribute	System serving status	Google Ads API v24 ad_group_criterion	Output only. Serving status of the criterion.
ad_group_criterion.topic.path	official_attribute	Path	Google Ads API v24 ad_group_criterion	The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category.
ad_group_criterion.topic.topic_constant	official_attribute	Topic constant	Google Ads API v24 ad_group_criterion	The Topic Constant resource name.
ad_group_criterion.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 ad_group_criterion	The URL template for constructing a tracking URL.
ad_group_criterion.type	official_attribute	Type	Google Ads API v24 ad_group_criterion	Output only. The type of the criterion.
ad_group_criterion.url_custom_parameters	official_attribute	Url custom parameters	Google Ads API v24 ad_group_criterion	The list of mappings used to substitute custom parameter tags in a tracking_url_template , final_urls , or mobile_final_urls .
ad_group_criterion.user_interest.user_interest_category	official_attribute	User interest category	Google Ads API v24 ad_group_criterion	The UserInterest resource name.
ad_group_criterion.user_list.user_list	official_attribute	User list	Google Ads API v24 ad_group_criterion	The User List resource name.
ad_group_criterion.vertical_ads_item_group_rule_list.shared_set	official_attribute	Shared set	Google Ads API v24 ad_group_criterion	The shared set resource name of the vertical ads item group rule list.
ad_group_criterion.video_lineup.video_lineup_id	official_attribute	Video lineup id	Google Ads API v24 ad_group_criterion	ID for a Video lineup. Contact your Google business development representative for details.
ad_group_criterion.webpage.conditions	official_attribute	Conditions	Google Ads API v24 ad_group_criterion	Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is require…
ad_group_criterion.webpage.coverage_percentage	official_attribute	Coverage percentage	Google Ads API v24 ad_group_criterion	Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 10…
ad_group_criterion.webpage.criterion_name	official_attribute	Criterion name	Google Ads API v24 ad_group_criterion	The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
ad_group_criterion.webpage.sample.sample_urls	official_attribute	Sample urls	Google Ads API v24 ad_group_criterion	Webpage sample urls
ad_group_criterion.youtube_channel.channel_id	official_attribute	Channel id	Google Ads API v24 ad_group_criterion	The YouTube uploader channel id or the channel code of a YouTube channel.
ad_group_criterion.youtube_video.video_id	official_attribute	Video id	Google Ads API v24 ad_group_criterion	YouTube video id as it appears on the YouTube watch page.
keyword_view.resource_name	official_attribute	Resource name	Google Ads API v24 keyword_view	Output only. The resource name of the keyword view. Keyword view resource names have the form: customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}
search_term_view.ad_group	official_attribute	Ad group	Google Ads API v24 search_term_view	Output only. The ad group the search term served in.
search_term_view.resource_name	official_attribute	Resource name	Google Ads API v24 search_term_view	Output only. The resource name of the search term view. Search term view resource names have the form: customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}
search_term_view.search_term	official_attribute	Search term	Google Ads API v24 search_term_view	Output only. The search term.
search_term_view.status	official_attribute	Status	Google Ads API v24 search_term_view	Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
shopping_performance_view.resource_name	official_attribute	Resource name	Google Ads API v24 shopping_performance_view	Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView
product_group_view.resource_name	official_attribute	Resource name	Google Ads API v24 product_group_view	Output only. The resource name of the product group view. Product group view resource names have the form: customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}
asset.app_deep_link_asset.app_deep_link_uri	official_attribute	App deep link uri	Google Ads API v24 asset	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 ).
asset.book_on_google_asset	official_attribute	Book on google asset	Google Ads API v24 asset	A book on google asset.
asset.business_message_asset.call_to_action.call_to_action_description	official_attribute	Call to action description	Google Ads API v24 asset	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'.
asset.business_message_asset.call_to_action.call_to_action_selection	official_attribute	Call to action selection	Google Ads API v24 asset	Required. Pre-defined call to action text.
asset.business_message_asset.facebook_messenger_info.page_name	official_attribute	Page name	Google Ads API v24 asset	Required. Facebook page name used for starting a chat on Facebook Messenger.
asset.business_message_asset.message_provider	official_attribute	Message provider	Google Ads API v24 asset	Required. Message provider of the business message asset.
asset.business_message_asset.starter_message	official_attribute	Starter message	Google Ads API v24 asset	Required. A welcome message to prompt the user to initiate a conversation.
asset.business_message_asset.whatsapp_info.country_code	official_attribute	Country code	Google Ads API v24 asset	Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
asset.business_message_asset.whatsapp_info.phone_number	official_attribute	Phone number	Google Ads API v24 asset	Required. Whatsapp phone number of the business. Examples: '1234567890', '(123)456-7890'.
asset.business_message_asset.zalo_info.custom_name	official_attribute	Custom name	Google Ads API v24 asset	Custom name generated by the advertiser for their Zalo Account. These names will usually be registered brands or trademarks.
asset.business_message_asset.zalo_info.oa_id	official_attribute	Oa id	Google Ads API v24 asset	Zalo Official Account ID of the advertiser.
asset.call_asset.ad_schedule_targets	official_attribute	Ad schedule targets	Google Ads API v24 asset	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.
asset.call_asset.call_conversion_action	official_attribute	Call conversion action	Google Ads API v24 asset	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.
asset.call_asset.call_conversion_reporting_state	official_attribute	Call conversion reporting state	Google Ads API v24 asset	Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
asset.call_asset.country_code	official_attribute	Country code	Google Ads API v24 asset	Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
asset.call_asset.phone_number	official_attribute	Phone number	Google Ads API v24 asset	Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
asset.call_to_action_asset.call_to_action	official_attribute	Call to action	Google Ads API v24 asset	Call to action.
asset.callout_asset.ad_schedule_targets	official_attribute	Ad schedule targets	Google Ads API v24 asset	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.
asset.callout_asset.callout_text	official_attribute	Callout text	Google Ads API v24 asset	Required. The callout text. The length of this string should be between 1 and 25, inclusive.
asset.callout_asset.end_date	official_attribute	End date	Google Ads API v24 asset	Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
asset.callout_asset.start_date	official_attribute	Start date	Google Ads API v24 asset	Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
asset.demand_gen_carousel_card_asset.call_to_action_text	official_attribute	Call to action text	Google Ads API v24 asset	Call to action text.
asset.demand_gen_carousel_card_asset.headline	official_attribute	Headline	Google Ads API v24 asset	Required. Headline of the carousel card.
asset.demand_gen_carousel_card_asset.marketing_image_asset	official_attribute	Marketing image asset	Google Ads API v24 asset	Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.
asset.demand_gen_carousel_card_asset.portrait_marketing_image_asset	official_attribute	Portrait marketing image asset	Google Ads API v24 asset	Asset resource name of the associated 4:5 portrait marketing image.
asset.demand_gen_carousel_card_asset.square_marketing_image_asset	official_attribute	Square marketing image asset	Google Ads API v24 asset	Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.
asset.dynamic_custom_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_custom_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Sedans, 4 door sedans.
asset.dynamic_custom_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $20,000.00.
asset.dynamic_custom_asset.formatted_sale_price	official_attribute	Formatted sale price	Google Ads API v24 asset	Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $15,000.00.
asset.dynamic_custom_asset.id	official_attribute	Id	Google Ads API v24 asset	Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, for example, sedan. Required.
asset.dynamic_custom_asset.id2	official_attribute	Id2	Google Ads API v24 asset	ID2 which can be any sequence of letters and digits, for example, red. ID sequence (ID + ID2) must be unique.
asset.dynamic_custom_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_custom_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_custom_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_custom_asset.item_address	official_attribute	Item address	Google Ads API v24 asset	Item address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for e…
asset.dynamic_custom_asset.item_category	official_attribute	Item category	Google Ads API v24 asset	Item category, for example, Sedans.
asset.dynamic_custom_asset.item_description	official_attribute	Item description	Google Ads API v24 asset	Item description, for example, Best selling mid-size car.
asset.dynamic_custom_asset.item_subtitle	official_attribute	Item subtitle	Google Ads API v24 asset	Item subtitle, for example, At your Mountain View dealership.
asset.dynamic_custom_asset.item_title	official_attribute	Item title	Google Ads API v24 asset	Required. Item title, for example, Mid-size sedan. Required.
asset.dynamic_custom_asset.price	official_attribute	Price	Google Ads API v24 asset	Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 20,000.00 USD.
asset.dynamic_custom_asset.sale_price	official_attribute	Sale price	Google Ads API v24 asset	Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 15,000.00 USD. Must be less than the 'price' field.
asset.dynamic_custom_asset.similar_ids	official_attribute	Similar ids	Google Ads API v24 asset	Similar IDs.
asset.dynamic_education_asset.address	official_attribute	Address	Google Ads API v24 asset	School address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for…
asset.dynamic_education_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_education_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Nursing certification, Health, Mountain View.
asset.dynamic_education_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image url, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_education_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_education_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_education_asset.location_id	official_attribute	Location id	Google Ads API v24 asset	Location ID which can be any sequence of letters and digits and must be unique.
asset.dynamic_education_asset.program_description	official_attribute	Program description	Google Ads API v24 asset	Program description, for example, Nursing Certification.
asset.dynamic_education_asset.program_id	official_attribute	Program id	Google Ads API v24 asset	Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_education_asset.program_name	official_attribute	Program name	Google Ads API v24 asset	Required. Program name, for example, Nursing. Required.
asset.dynamic_education_asset.school_name	official_attribute	School name	Google Ads API v24 asset	School name, for example, Mountain View School of Nursing.
asset.dynamic_education_asset.similar_program_ids	official_attribute	Similar program ids	Google Ads API v24 asset	Similar program IDs.
asset.dynamic_education_asset.subject	official_attribute	Subject	Google Ads API v24 asset	Subject of study, for example, Health.
asset.dynamic_education_asset.thumbnail_image_url	official_attribute	Thumbnail image url	Google Ads API v24 asset	Thumbnail image url, for example, http://www.example.com/thumbnail.png . The thumbnail image will not be uploaded as image asset.
asset.dynamic_flights_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_flights_asset.custom_mapping	official_attribute	Custom mapping	Google Ads API v24 asset	A custom field which can be multiple key to values mapping separated by delimiters (",", "\|" and ":"), in the forms of ": , , ... , \| : , ... , \| ... \| : , ... ," for example, wifi: most \| aircraft: 320, 77W \| flights: 42 \| legroom: 32".
asset.dynamic_flights_asset.destination_id	official_attribute	Destination id	Google Ads API v24 asset	Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_flights_asset.destination_name	official_attribute	Destination name	Google Ads API v24 asset	Destination name, for example, Paris.
asset.dynamic_flights_asset.flight_description	official_attribute	Flight description	Google Ads API v24 asset	Required. Flight description, for example, Book your ticket. Required.
asset.dynamic_flights_asset.flight_price	official_attribute	Flight price	Google Ads API v24 asset	Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
asset.dynamic_flights_asset.flight_sale_price	official_attribute	Flight sale price	Google Ads API v24 asset	Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'flight_price' field.
asset.dynamic_flights_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
asset.dynamic_flights_asset.formatted_sale_price	official_attribute	Formatted sale price	Google Ads API v24 asset	Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
asset.dynamic_flights_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_flights_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_flights_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_flights_asset.origin_id	official_attribute	Origin id	Google Ads API v24 asset	Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
asset.dynamic_flights_asset.origin_name	official_attribute	Origin name	Google Ads API v24 asset	Origin name, for example, London.
asset.dynamic_flights_asset.similar_destination_ids	official_attribute	Similar destination ids	Google Ads API v24 asset	Similar destination IDs, for example, PAR,LON.
asset.dynamic_hotels_and_rentals_asset.address	official_attribute	Address	Google Ads API v24 asset	Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for exampl…
asset.dynamic_hotels_and_rentals_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_hotels_and_rentals_asset.category	official_attribute	Category	Google Ads API v24 asset	Category, for example, Hotel suite.
asset.dynamic_hotels_and_rentals_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Mountain View "Hotels", South Bay hotels.
asset.dynamic_hotels_and_rentals_asset.description	official_attribute	Description	Google Ads API v24 asset	Description, for example, Close to SJC Airport.
asset.dynamic_hotels_and_rentals_asset.destination_name	official_attribute	Destination name	Google Ads API v24 asset	Destination name, for example, Downtown Mountain View.
asset.dynamic_hotels_and_rentals_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
asset.dynamic_hotels_and_rentals_asset.formatted_sale_price	official_attribute	Formatted sale price	Google Ads API v24 asset	Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
asset.dynamic_hotels_and_rentals_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_hotels_and_rentals_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_hotels_and_rentals_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_hotels_and_rentals_asset.price	official_attribute	Price	Google Ads API v24 asset	Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
asset.dynamic_hotels_and_rentals_asset.property_id	official_attribute	Property id	Google Ads API v24 asset	Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_hotels_and_rentals_asset.property_name	official_attribute	Property name	Google Ads API v24 asset	Required. Property name, for example, Mountain View Hotel. Required.
asset.dynamic_hotels_and_rentals_asset.sale_price	official_attribute	Sale price	Google Ads API v24 asset	ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
asset.dynamic_hotels_and_rentals_asset.similar_property_ids	official_attribute	Similar property ids	Google Ads API v24 asset	Similar property IDs.
asset.dynamic_hotels_and_rentals_asset.star_rating	official_attribute	Star rating	Google Ads API v24 asset	Star rating. Must be a number between 1 to 5, inclusive.
asset.dynamic_jobs_asset.address	official_attribute	Address	Google Ads API v24 asset	Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for exampl…
asset.dynamic_jobs_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_jobs_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Software engineering job.
asset.dynamic_jobs_asset.description	official_attribute	Description	Google Ads API v24 asset	Description, for example, Apply your technical skills.
asset.dynamic_jobs_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_jobs_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_jobs_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_jobs_asset.job_category	official_attribute	Job category	Google Ads API v24 asset	Job category, for example, Technical.
asset.dynamic_jobs_asset.job_id	official_attribute	Job id	Google Ads API v24 asset	Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_jobs_asset.job_subtitle	official_attribute	Job subtitle	Google Ads API v24 asset	Job subtitle, for example, Level II.
asset.dynamic_jobs_asset.job_title	official_attribute	Job title	Google Ads API v24 asset	Required. Job title, for example, Software engineer. Required.
asset.dynamic_jobs_asset.location_id	official_attribute	Location id	Google Ads API v24 asset	Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.
asset.dynamic_jobs_asset.salary	official_attribute	Salary	Google Ads API v24 asset	Salary, for example, $100,000.
asset.dynamic_jobs_asset.similar_job_ids	official_attribute	Similar job ids	Google Ads API v24 asset	Similar job IDs, for example, 1275.
asset.dynamic_local_asset.address	official_attribute	Address	Google Ads API v24 asset	Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for exampl…
asset.dynamic_local_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_local_asset.category	official_attribute	Category	Google Ads API v24 asset	Category, for example, Food.
asset.dynamic_local_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Save groceries coupons.
asset.dynamic_local_asset.deal_id	official_attribute	Deal id	Google Ads API v24 asset	Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_local_asset.deal_name	official_attribute	Deal name	Google Ads API v24 asset	Required. Deal name, for example, 50% off at Mountain View Grocers. Required.
asset.dynamic_local_asset.description	official_attribute	Description	Google Ads API v24 asset	Description, for example, Save on your weekly bill.
asset.dynamic_local_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
asset.dynamic_local_asset.formatted_sale_price	official_attribute	Formatted sale price	Google Ads API v24 asset	Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
asset.dynamic_local_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_local_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_local_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_local_asset.price	official_attribute	Price	Google Ads API v24 asset	Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
asset.dynamic_local_asset.sale_price	official_attribute	Sale price	Google Ads API v24 asset	Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
asset.dynamic_local_asset.similar_deal_ids	official_attribute	Similar deal ids	Google Ads API v24 asset	Similar deal IDs, for example, 1275.
asset.dynamic_local_asset.subtitle	official_attribute	Subtitle	Google Ads API v24 asset	Subtitle, for example, Groceries.
asset.dynamic_real_estate_asset.address	official_attribute	Address	Google Ads API v24 asset	Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for exampl…
asset.dynamic_real_estate_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_real_estate_asset.city_name	official_attribute	City name	Google Ads API v24 asset	City name, for example, Mountain View, California.
asset.dynamic_real_estate_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, For sale; Houses for sale.
asset.dynamic_real_estate_asset.description	official_attribute	Description	Google Ads API v24 asset	Description, for example, 3 beds, 2 baths, 1568 sq. ft.
asset.dynamic_real_estate_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $200,000.00.
asset.dynamic_real_estate_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_real_estate_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_real_estate_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_real_estate_asset.listing_id	official_attribute	Listing id	Google Ads API v24 asset	Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_real_estate_asset.listing_name	official_attribute	Listing name	Google Ads API v24 asset	Required. Listing name, for example, Boulevard Bungalow. Required.
asset.dynamic_real_estate_asset.listing_type	official_attribute	Listing type	Google Ads API v24 asset	Listing type, for example, For sale.
asset.dynamic_real_estate_asset.price	official_attribute	Price	Google Ads API v24 asset	Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 200,000.00 USD.
asset.dynamic_real_estate_asset.property_type	official_attribute	Property type	Google Ads API v24 asset	Property type, for example, House.
asset.dynamic_real_estate_asset.similar_listing_ids	official_attribute	Similar listing ids	Google Ads API v24 asset	Similar listing IDs.
asset.dynamic_travel_asset.android_app_link	official_attribute	Android app link	Google Ads API v24 asset	Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
asset.dynamic_travel_asset.category	official_attribute	Category	Google Ads API v24 asset	Category, for example, Express.
asset.dynamic_travel_asset.contextual_keywords	official_attribute	Contextual keywords	Google Ads API v24 asset	Contextual keywords, for example, Paris trains.
asset.dynamic_travel_asset.destination_address	official_attribute	Destination address	Google Ads API v24 asset	Destination address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format…
asset.dynamic_travel_asset.destination_id	official_attribute	Destination id	Google Ads API v24 asset	Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
asset.dynamic_travel_asset.destination_name	official_attribute	Destination name	Google Ads API v24 asset	Destination name, for example, Paris.
asset.dynamic_travel_asset.formatted_price	official_attribute	Formatted price	Google Ads API v24 asset	Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
asset.dynamic_travel_asset.formatted_sale_price	official_attribute	Formatted sale price	Google Ads API v24 asset	Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
asset.dynamic_travel_asset.image_url	official_attribute	Image url	Google Ads API v24 asset	Image URL, for example, http://www.example.com/image.png . The image will not be uploaded as image asset.
asset.dynamic_travel_asset.ios_app_link	official_attribute	Ios app link	Google Ads API v24 asset	iOS deep link, for example, exampleApp://content/page.
asset.dynamic_travel_asset.ios_app_store_id	official_attribute	Ios app store id	Google Ads API v24 asset	iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
asset.dynamic_travel_asset.origin_id	official_attribute	Origin id	Google Ads API v24 asset	Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
asset.dynamic_travel_asset.origin_name	official_attribute	Origin name	Google Ads API v24 asset	Origin name, for example, London.
asset.dynamic_travel_asset.price	official_attribute	Price	Google Ads API v24 asset	Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
asset.dynamic_travel_asset.sale_price	official_attribute	Sale price	Google Ads API v24 asset	Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
asset.dynamic_travel_asset.similar_destination_ids	official_attribute	Similar destination ids	Google Ads API v24 asset	Similar destination IDs, for example, NYC.
asset.dynamic_travel_asset.title	official_attribute	Title	Google Ads API v24 asset	Required. Title, for example, Book your train ticket. Required.
asset.field_type_policy_summaries	official_attribute	Field type policy summaries	Google Ads API v24 asset	Output only. Policy information for the asset for each FieldType.
asset.final_mobile_urls	official_attribute	Final mobile urls	Google Ads API v24 asset	A list of possible final mobile URLs after all cross domain redirects.
asset.final_url_suffix	official_attribute	Final url suffix	Google Ads API v24 asset	URL template for appending params to landing page URLs served with parallel tracking.
asset.final_urls	official_attribute	Final urls	Google Ads API v24 asset	A list of possible final URLs after all cross domain redirects.
asset.hotel_callout_asset.language_code	official_attribute	Language code	Google Ads API v24 asset	Required. The language of the hotel callout. Represented as BCP 47 language tag.
asset.hotel_callout_asset.text	official_attribute	Text	Google Ads API v24 asset	Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.
asset.hotel_property_asset.hotel_address	official_attribute	Hotel address	Google Ads API v24 asset	Address of the hotel. Read-only.
asset.hotel_property_asset.hotel_name	official_attribute	Hotel name	Google Ads API v24 asset	Name of the hotel. Read-only.
asset.hotel_property_asset.place_id	official_attribute	Place id	Google Ads API v24 asset	Place IDs uniquely identify a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id to learn more.
asset.id	official_attribute	Id	Google Ads API v24 asset	Output only. The ID of the asset.
asset.image_asset.file_size	official_attribute	File size	Google Ads API v24 asset	File size of the image asset in bytes.
asset.image_asset.full_size.height_pixels	official_attribute	Height pixels	Google Ads API v24 asset	Height of the image.
asset.image_asset.full_size.url	official_attribute	Url	Google Ads API v24 asset	A URL that returns the image with this height and width.
asset.image_asset.full_size.width_pixels	official_attribute	Width pixels	Google Ads API v24 asset	Width of the image.
asset.image_asset.mime_type	official_attribute	Mime type	Google Ads API v24 asset	MIME type of the image asset.
asset.lead_form_asset.background_image_asset	official_attribute	Background image asset	Google Ads API v24 asset	Asset resource name of the background image. The image dimensions must be exactly 1200x628.
asset.lead_form_asset.business_name	official_attribute	Business name	Google Ads API v24 asset	Required. The name of the business being advertised.
asset.lead_form_asset.call_to_action_description	official_attribute	Call to action description	Google Ads API v24 asset	Required. Text giving a clear value proposition of what users expect once they expand the form.
asset.lead_form_asset.call_to_action_type	official_attribute	Call to action type	Google Ads API v24 asset	Required. Pre-defined display text that encourages user to expand the form.
asset.lead_form_asset.custom_disclosure	official_attribute	Custom disclosure	Google Ads API v24 asset	Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.
asset.lead_form_asset.custom_question_fields	official_attribute	Custom question fields	Google Ads API v24 asset	Ordered list of custom question fields. This field is subject to a limit of 5 qualifying questions per form.
asset.lead_form_asset.delivery_methods	official_attribute	Delivery methods	Google Ads API v24 asset	Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.
asset.lead_form_asset.description	official_attribute	Description	Google Ads API v24 asset	Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.
asset.lead_form_asset.desired_intent	official_attribute	Desired intent	Google Ads API v24 asset	Chosen intent for the lead form, for example, more volume or more qualified.
asset.lead_form_asset.fields	official_attribute	Fields	Google Ads API v24 asset	Ordered list of input fields. This field can be updated by reordering questions, but not by adding or removing questions.
asset.lead_form_asset.headline	official_attribute	Headline	Google Ads API v24 asset	Required. Headline of the expanded form to describe what the form is asking for or facilitating.
asset.lead_form_asset.post_submit_call_to_action_type	official_attribute	Post submit call to action type	Google Ads API v24 asset	Pre-defined display text that encourages user action after the form is submitted.
asset.lead_form_asset.post_submit_description	official_attribute	Post submit description	Google Ads API v24 asset	Detailed description shown after form submission that describes how the advertiser will follow up with the user.
asset.lead_form_asset.post_submit_headline	official_attribute	Post submit headline	Google Ads API v24 asset	Headline of text shown after form submission that describes how the advertiser will follow up with the user.
asset.lead_form_asset.privacy_policy_url	official_attribute	Privacy policy url	Google Ads API v24 asset	Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.
asset.location_asset.business_profile_locations	official_attribute	Business profile locations	Google Ads API v24 asset	The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
asset.location_asset.location_ownership_type	official_attribute	Location ownership type	Google Ads API v24 asset	The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.
asset.location_asset.place_id	official_attribute	Place id	Google Ads API v24 asset	Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
asset.mobile_app_asset.app_id	official_attribute	App id	Google Ads API v24 asset	Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
asset.mobile_app_asset.app_store	official_attribute	App store	Google Ads API v24 asset	Required. The application store that distributes this specific app.
asset.mobile_app_asset.end_date	official_attribute	End date	Google Ads API v24 asset	Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
asset.mobile_app_asset.link_text	official_attribute	Link text	Google Ads API v24 asset	Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive.
asset.mobile_app_asset.start_date	official_attribute	Start date	Google Ads API v24 asset	Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
asset.name	official_attribute	Name	Google Ads API v24 asset	Optional name of the asset.
asset.orientation	official_attribute	Orientation	Google Ads API v24 asset	Output only. Orientation of the asset. This is only supported for image and video assets.
asset.page_feed_asset.labels	official_attribute	Labels	Google Ads API v24 asset	Labels used to group the page urls.
asset.page_feed_asset.page_url	official_attribute	Page url	Google Ads API v24 asset	Required. The webpage that advertisers want to target.
asset.policy_summary.approval_status	official_attribute	Approval status	Google Ads API v24 asset	Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.
asset.policy_summary.policy_topic_entries	official_attribute	Policy topic entries	Google Ads API v24 asset	Output only. The list of policy findings for this asset.
asset.policy_summary.review_status	official_attribute	Review status	Google Ads API v24 asset	Output only. Where in the review process this asset is.
asset.price_asset.language_code	official_attribute	Language code	Google Ads API v24 asset	Required. The language of the price asset. Represented as BCP 47 language tag.
asset.price_asset.price_offerings	official_attribute	Price offerings	Google Ads API v24 asset	The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.
asset.price_asset.price_qualifier	official_attribute	Price qualifier	Google Ads API v24 asset	The price qualifier of the price asset.
asset.price_asset.type	official_attribute	Type	Google Ads API v24 asset	Required. The type of the price asset.
asset.promotion_asset.ad_schedule_targets	official_attribute	Ad schedule targets	Google Ads API v24 asset	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.
asset.promotion_asset.discount_modifier	official_attribute	Discount modifier	Google Ads API v24 asset	A modifier for qualification of the discount.
asset.promotion_asset.end_date	official_attribute	End date	Google Ads API v24 asset	Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
asset.promotion_asset.language_code	official_attribute	Language code	Google Ads API v24 asset	The language of the promotion. Represented as BCP 47 language tag.
asset.promotion_asset.money_amount_off.amount_micros	official_attribute	Amount micros	Google Ads API v24 asset	Amount in micros. One million is equivalent to one unit.
asset.promotion_asset.money_amount_off.currency_code	official_attribute	Currency code	Google Ads API v24 asset	Three-character ISO 4217 currency code.
asset.promotion_asset.occasion	official_attribute	Occasion	Google Ads API v24 asset	The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.
asset.promotion_asset.orders_over_amount.amount_micros	official_attribute	Amount micros	Google Ads API v24 asset	Amount in micros. One million is equivalent to one unit.
asset.promotion_asset.orders_over_amount.currency_code	official_attribute	Currency code	Google Ads API v24 asset	Three-character ISO 4217 currency code.
asset.promotion_asset.percent_off	official_attribute	Percent off	Google Ads API v24 asset	Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required.
asset.promotion_asset.promotion_barcode_info.barcode_content	official_attribute	Barcode content	Google Ads API v24 asset	Promotion message to be encoded in the barcode.
asset.promotion_asset.promotion_barcode_info.type	official_attribute	Type	Google Ads API v24 asset	Barcode type used to generate barcode with the correct format.
asset.promotion_asset.promotion_code	official_attribute	Promotion code	Google Ads API v24 asset	A code the user should use in order to be eligible for the promotion.
asset.promotion_asset.promotion_qr_code_info.qr_code_content	official_attribute	Qr code content	Google Ads API v24 asset	Promotion message to be encoded in the QR code.
asset.promotion_asset.promotion_target	official_attribute	Promotion target	Google Ads API v24 asset	Required. A freeform description of what the promotion is targeting.
asset.promotion_asset.redemption_end_date	official_attribute	Redemption end date	Google Ads API v24 asset	Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
asset.promotion_asset.redemption_start_date	official_attribute	Redemption start date	Google Ads API v24 asset	Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
asset.promotion_asset.start_date	official_attribute	Start date	Google Ads API v24 asset	Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
asset.promotion_asset.terms_and_conditions_text	official_attribute	Terms and conditions text	Google Ads API v24 asset	Terms and conditions of the promotion.
asset.promotion_asset.terms_and_conditions_uri	official_attribute	Terms and conditions uri	Google Ads API v24 asset	URI to the terms and conditions of the promotion.
asset.resource_name	official_attribute	Resource name	Google Ads API v24 asset	Immutable. The resource name of the asset. Asset resource names have the form: customers/{customer_id}/assets/{asset_id}
asset.sitelink_asset.ad_schedule_targets	official_attribute	Ad schedule targets	Google Ads API v24 asset	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.
asset.sitelink_asset.description1	official_attribute	Description1	Google Ads API v24 asset	First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
asset.sitelink_asset.description2	official_attribute	Description2	Google Ads API v24 asset	Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
asset.sitelink_asset.end_date	official_attribute	End date	Google Ads API v24 asset	Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
asset.sitelink_asset.link_text	official_attribute	Link text	Google Ads API v24 asset	Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
asset.sitelink_asset.start_date	official_attribute	Start date	Google Ads API v24 asset	Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
asset.source	official_attribute	Source	Google Ads API v24 asset	Output only. Source of the asset.
asset.structured_snippet_asset.header	official_attribute	Header	Google Ads API v24 asset	Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
asset.structured_snippet_asset.values	official_attribute	Values	Google Ads API v24 asset	Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive.
asset.synthetic_content_info.advertiser_attestation.source	official_attribute	Source	Google Ads API v24 asset	The source of the synthetic content attestation.
asset.synthetic_content_info.advertiser_attestation.status	official_attribute	Status	Google Ads API v24 asset	Indicates whether the content is considered synthetic by this source.
asset.synthetic_content_info.system_attestation.source	official_attribute	Source	Google Ads API v24 asset	The source of the synthetic content attestation.
asset.synthetic_content_info.system_attestation.status	official_attribute	Status	Google Ads API v24 asset	Indicates whether the content is considered synthetic by this source.
asset.text_asset.text	official_attribute	Text	Google Ads API v24 asset	Text content of the text asset.
asset.tracking_url_template	official_attribute	Tracking url template	Google Ads API v24 asset	URL template for constructing a tracking URL.
asset.type	official_attribute	Type	Google Ads API v24 asset	Output only. Type of the asset.
asset.url_custom_parameters	official_attribute	Url custom parameters	Google Ads API v24 asset	A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
asset.youtube_video_asset.youtube_video_id	official_attribute	Youtube video id	Google Ads API v24 asset	YouTube video id. This is the 11 character string value used in the YouTube video URL.
asset.youtube_video_asset.youtube_video_title	official_attribute	Youtube video title	Google Ads API v24 asset	YouTube video title.
asset.youtube_video_list_asset.youtube_videos	official_attribute	Youtube videos	Google Ads API v24 asset	List of videos. Each is a reference to a YouTube video asset. Minimum of 2 videos required and maximum of 5 allowed.
asset.youtube_video_list_asset.youtube_videos.asset	official_attribute	Asset	Google Ads API v24 asset	The Asset resource name of this video.
asset_group.ad_strength	official_attribute	Ad strength	Google Ads API v24 asset_group	Output only. Overall ad strength of this asset group.
asset_group.asset_coverage.ad_strength_action_items	official_attribute	Ad strength action items	Google Ads API v24 asset_group	Output only. A list of action items to improve the ad strength of an asset group.
asset_group.campaign	official_attribute	Campaign	Google Ads API v24 asset_group	Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
asset_group.final_mobile_urls	official_attribute	Final mobile urls	Google Ads API v24 asset_group	A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
asset_group.final_urls	official_attribute	Final urls	Google Ads API v24 asset_group	A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
asset_group.google_local_services_info.callouts	official_attribute	Callouts	Google Ads API v24 asset_group	Callouts selected by the advertiser to show.
asset_group.google_local_services_info.category_id	official_attribute	Category id	Google Ads API v24 asset_group	Immutable. The local services category associated with this asset group. That is, XCAT format - xcat:service_area_business_plumber. See https://developers.google.com/google-ads/api/data/codes-formats#local-services-category-ids This field cannot be modified a…
asset_group.id	official_attribute	Id	Google Ads API v24 asset_group	Output only. The ID of the asset group.
asset_group.name	official_attribute	Name	Google Ads API v24 asset_group	Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
asset_group.path1	official_attribute	Path1	Google Ads API v24 asset_group	First part of text that may appear appended to the url displayed in the ad.
asset_group.path2	official_attribute	Path2	Google Ads API v24 asset_group	Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
asset_group.primary_status	official_attribute	Primary status	Google Ads API v24 asset_group	Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
asset_group.primary_status_reasons	official_attribute	Primary status reasons	Google Ads API v24 asset_group	Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
asset_group.resource_name	official_attribute	Resource name	Google Ads API v24 asset_group	Immutable. The resource name of the asset group. Asset group resource names have the form: customers/{customer_id}/assetGroups/{asset_group_id}
asset_group.status	official_attribute	Status	Google Ads API v24 asset_group	The status of the asset group.
asset_group_product_group_view.asset_group	official_attribute	Asset group	Google Ads API v24 asset_group_product_group_view	Output only. The asset group associated with the listing group filter.
asset_group_product_group_view.asset_group_listing_group_filter	official_attribute	Asset group listing group filter	Google Ads API v24 asset_group_product_group_view	Output only. The resource name of the asset group listing group filter.
asset_group_product_group_view.resource_name	official_attribute	Resource name	Google Ads API v24 asset_group_product_group_view	Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: customers/{customer_id}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}
conversion_action.app_id	official_attribute	App id	Google Ads API v24 conversion_action	App ID for an app conversion action.
conversion_action.attribution_model_settings.attribution_model	official_attribute	Attribution model	Google Ads API v24 conversion_action	The attribution model type of this conversion action.
conversion_action.attribution_model_settings.data_driven_model_status	official_attribute	Data driven model status	Google Ads API v24 conversion_action	Output only. The status of the data-driven attribution model for the conversion action.
conversion_action.category	official_attribute	Category	Google Ads API v24 conversion_action	The category of conversions reported for this conversion action.
conversion_action.click_through_lookback_window_days	official_attribute	Click through lookback window days	Google Ads API v24 conversion_action	The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
conversion_action.counting_type	official_attribute	Counting type	Google Ads API v24 conversion_action	How to count conversion events for the conversion action.
conversion_action.firebase_settings.event_name	official_attribute	Event name	Google Ads API v24 conversion_action	Output only. The event name of a Firebase conversion.
conversion_action.firebase_settings.project_id	official_attribute	Project id	Google Ads API v24 conversion_action	Output only. The Firebase project ID of the conversion.
conversion_action.firebase_settings.property_id	official_attribute	Property id	Google Ads API v24 conversion_action	Output only. The GA property ID of the conversion.
conversion_action.firebase_settings.property_name	official_attribute	Property name	Google Ads API v24 conversion_action	Output only. The GA property name of the conversion.
conversion_action.google_analytics_4_settings.event_name	official_attribute	Event name	Google Ads API v24 conversion_action	Output only. The name of the GA 4 event.
conversion_action.google_analytics_4_settings.property_id	official_attribute	Property id	Google Ads API v24 conversion_action	Output only. The ID of the GA 4 property.
conversion_action.google_analytics_4_settings.property_name	official_attribute	Property name	Google Ads API v24 conversion_action	Output only. The name of the GA 4 property.
conversion_action.id	official_attribute	Id	Google Ads API v24 conversion_action	Output only. The ID of the conversion action.
conversion_action.include_in_conversions_metric	official_attribute	Include in conversions metric	Google Ads API v24 conversion_action	Whether this conversion action should be included in the "conversions" metric.
conversion_action.mobile_app_vendor	official_attribute	Mobile app vendor	Google Ads API v24 conversion_action	Output only. Mobile app vendor for an app conversion action.
conversion_action.name	official_attribute	Name	Google Ads API v24 conversion_action	The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
conversion_action.origin	official_attribute	Origin	Google Ads API v24 conversion_action	Output only. The conversion origin of this conversion action.
conversion_action.owner_customer	official_attribute	Owner customer	Google Ads API v24 conversion_action	Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
conversion_action.phone_call_duration_seconds	official_attribute	Phone call duration seconds	Google Ads API v24 conversion_action	The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.
conversion_action.primary_for_goal	official_attribute	Primary for goal	Google Ads API v24 conversion_action	If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a…
conversion_action.resource_name	official_attribute	Resource name	Google Ads API v24 conversion_action	Immutable. The resource name of the conversion action. Conversion action resource names have the form: customers/{customer_id}/conversionActions/{conversion_action_id}
conversion_action.status	official_attribute	Status	Google Ads API v24 conversion_action	The status of this conversion action for conversion event accrual.
conversion_action.tag_snippets	official_attribute	Tag snippets	Google Ads API v24 conversion_action	Output only. The snippets used for tracking conversions.
conversion_action.third_party_app_analytics_settings.event_name	official_attribute	Event name	Google Ads API v24 conversion_action	Output only. The event name of a third-party app analytics conversion.
conversion_action.third_party_app_analytics_settings.provider_name	official_attribute	Provider name	Google Ads API v24 conversion_action	Output only. Name of the third-party app analytics provider.
conversion_action.type	official_attribute	Type	Google Ads API v24 conversion_action	Immutable. The type of this conversion action.
conversion_action.value_settings.always_use_default_value	official_attribute	Always use default value	Google Ads API v24 conversion_action	Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
conversion_action.value_settings.default_currency_code	official_attribute	Default currency code	Google Ads API v24 conversion_action	The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
conversion_action.value_settings.default_value	official_attribute	Default value	Google Ads API v24 conversion_action	The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
conversion_action.view_through_lookback_window_days	official_attribute	View through lookback window days	Google Ads API v24 conversion_action	The maximum number of days which may elapse between an impression and a conversion without an interaction.
customer_client.applied_labels	official_attribute	Applied labels	Google Ads API v24 customer_client	Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: customers/{customer_id}/labels/{label_id}
customer_client.client_customer	official_attribute	Client customer	Google Ads API v24 customer_client	Output only. The resource name of the client-customer which is linked to the given customer. Read only.
customer_client.currency_code	official_attribute	Currency code	Google Ads API v24 customer_client	Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
customer_client.descriptive_name	official_attribute	Descriptive name	Google Ads API v24 customer_client	Output only. Descriptive name for the client. Read only.
customer_client.hidden	official_attribute	Hidden	Google Ads API v24 customer_client	Output only. Specifies whether this is a hidden account . Read only.
customer_client.id	official_attribute	Id	Google Ads API v24 customer_client	Output only. The ID of the client customer. Read only.
customer_client.level	official_attribute	Level	Google Ads API v24 customer_client	Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
customer_client.manager	official_attribute	Manager	Google Ads API v24 customer_client	Output only. Identifies if the client is a manager. Read only.
customer_client.resource_name	official_attribute	Resource name	Google Ads API v24 customer_client	Output only. The resource name of the customer client. CustomerClient resource names have the form: customers/{customer_id}/customerClients/{client_customer_id}
customer_client.status	official_attribute	Status	Google Ads API v24 customer_client	Output only. The status of the client customer. Read only.
customer_client.test_account	official_attribute	Test account	Google Ads API v24 customer_client	Output only. Identifies if the client is a test account. Read only.
customer_client.time_zone	official_attribute	Time zone	Google Ads API v24 customer_client	Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
googleAdsFields.searchGoogleAdsFields	dynamic_catalog	GoogleAdsFieldService	GoogleAdsFieldService.SearchGoogleAdsFields	Google Ads APIのFieldServiceで、APIバージョンごとの全GoogleAdsFieldメタデータを検索できます。

LINEヤフー広告

広告 / LINEヤフー広告 OAuth

提供中

LINEヤフー広告の検索広告・ディスプレイ広告の費用、表示回数、クリック、CV、キャンペーン、広告グループ、広告、キーワードを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_yahoo_ads_accounts	なし	account_key / platform / platform_label / account_id / account_name	接続済みLINEヤフー広告アカウントを一覧化する
yahoo_ads_performance_summary	start_date, end_date, account_id, platform	cost / clicks / impressions / conversions	検索広告・ディスプレイ広告の実績を取得する
run_yahoo_ads_report	report_type, start_date, end_date, account_id, platform, limit	rows / ids / cost / conversions	キャンペーン・広告グループ・広告・キーワード別に取得する

フィールド

ID	型	表示名	媒体側API名	説明
ACCOUNT_ID	official_attribute	アカウントID	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Account ID
ACCOUNT_NAME	official_attribute	アカウント名	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Account Name
COST	official_metric	コスト	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (LONG)	Cost
IMPS	official_metric	インプレッション数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (LONG)	Impressions
CLICKS	official_metric	クリック数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (LONG)	Clicks
CLICK_RATE	official_metric	クリック率	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	CTR
AVG_CPC	official_metric	平均CPC	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Avg. CPC
INVALID_CLICKS	official_metric	無効なクリック数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (LONG)	Invalid clicks
INVALID_CLICK_RATE	official_metric	無効なクリック率	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Invalid Click Rate
IMPRESSION_SHARE	official_metric	インプレッションシェア	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Impression share
EXACT_MATCH_IMPRESSION_SHARE	official_metric	完全一致のインプレッションシェア	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Exact match impression share
BUDGET_LOST_IMPRESSION_SHARE	official_metric	インプレッションシェア損失率（予算）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Lost impression share (budget)
QUALITY_LOST_IMPRESSION_SHARE	official_metric	インプレッションシェア損失率（ランク）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Lost impression share (rank)
TRACKING_URL	official_attribute	トラッキングURL	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Tracking URL
CONVERSIONS	official_metric	コンバージョン数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conversions
CONV_RATE	official_metric	コンバージョン率	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. rate
CONV_VALUE	official_metric	コンバージョンの価値	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value
COST_PER_CONV	official_metric	コスト/コンバージョン数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Cost/conv.
VALUE_PER_CONV	official_metric	コンバージョンの価値/コンバージョン数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value/conv.
ALL_CONV	official_metric	コンバージョン数（全て）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conversions (all)
ALL_CONV_RATE	official_metric	コンバージョン率（全て）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. rate (all)
ALL_CONV_VALUE	official_metric	コンバージョンの価値（全て）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value (all)
COST_PER_ALL_CONV	official_metric	コスト/コンバージョン数（全て）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Cost/conv. (all)
VALUE_PER_ALL_CONV	official_metric	コンバージョンの価値（全て）/コンバージョン数（全て）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value (all)/conv. (all)
CROSS_DEVICE_CONVERSIONS	official_metric	クロスデバイスコンバージョン数	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
NETWORK	official_report_field	広告を表示する検索画面	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	Show ads on
CLICK_TYPE	official_report_field	クリック種別	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	ClickType
DEVICE	official_report_field	デバイス	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	Device
DAY	official_report_field	日	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Day
DAY_OF_WEEK	official_report_field	曜日	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	Day of the week
QUARTER	official_report_field	四半期	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Quarter
YEAR	official_report_field	年	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Year
MONTH	official_report_field	毎月	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Month
MONTH_OF_YEAR	official_report_field	月	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	Month of Year
WEEK	official_report_field	週（月～日）	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Week (Mon-Sun)
HOUR_OF_DAY	official_report_field	時間	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (LONG)	Hour of day
OBJECT_OF_CONVERSION_TRACKING	official_report_field	コンバージョン測定の目的	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (ENUM)	Conversion Tracking Purpose
CONVERSION_NAME	official_report_field	コンバージョン名	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (STRING)	Conversion name
CONV_VALUE_PER_COST	official_metric	コンバージョンの価値/コスト	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value/cost
ALL_CONV_VALUE_PER_COST	official_metric	コンバージョンの価値（全て）/コスト	Yahoo!広告 v19 ReportDefinitionService YSS_ACCOUNT (DOUBLE)	Conv. value (all)/cost
CAMPAIGN_ID	official_attribute	キャンペーンID	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (LONG)	CampaignID
CAMPAIGN_NAME	official_attribute	キャンペーン名	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Campaign name
CAMPAIGN_DISTRIBUTION_SETTINGS	official_attribute	キャンペーン配信設定	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	Distribution Settings
CAMPAIGN_DISTRIBUTION_STATUS	official_attribute	配信状況	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	Distribution Status
DAILY_SPENDING_LIMIT	official_attribute	1日の予算	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (LONG)	Daily Spending Limit
CAMPAIGN_START_DATE	official_attribute	開始日	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Start Date
CAMPAIGN_END_DATE	official_attribute	終了日	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	End Date
CUSTOM_PARAMETERS	official_attribute	カスタムパラメータ	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Custom parameter
CAMPAIGN_TRACKING_ID	official_attribute	キャンペーントラッキングID	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (LONG)	Campaign tracking ID
CAMPAIGN_TYPE	official_attribute	キャンペーンタイプ	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	Campaign type
LABELS	official_attribute	ラベル	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Label
LABELS_JSON	official_attribute	ラベル(JSON)	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Labels(JSON)
BID_STRATEGY_ID	official_attribute	ポートフォリオ入札ID	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (LONG)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
BID_STRATEGY_NAME	official_attribute	ポートフォリオ入札名	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Portfolio bidding name
BID_STRATEGY_TYPE	official_attribute	入札戦略	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	Bid strategy
BID_STRATEGY_STATUS	official_attribute	入札戦略の状況	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	Bid strategy status
ABSOLUTE_TOP_IMPRESSION_PERCENTAGE	official_metric	インプレッションにおけるページ最上部の割合	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search absolute top impression rate
TOP_IMPRESSION_PERCENTAGE	official_metric	インプレッションにおけるページ上部の割合	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search top impression rate
SEARCH_ABSOLUTE_TOP_IMPRESSION_SHARE	official_metric	ページ最上部のインプレッションシェア	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search absolute top impression share
SEARCH_TOP_IMPRESSION_SHARE	official_metric	ページ上部のインプレッションシェア	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search top impression share
SEARCH_BUDGET_LOST_ABSOLUTE_TOP_IMPRESSION_SHARE	official_metric	ページ最上部のインプレッションシェア損失率（予算）	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search absolute top impression share (budget)
SEARCH_RANK_LOST_ABSOLUTE_TOP_IMPRESSION_SHARE	official_metric	ページ最上部のインプレッションシェア損失率（ランク）	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search absolute top lost impression share (rank)
SEARCH_BUDGET_LOST_TOP_IMPRESSION_SHARE	official_metric	ページ上部のインプレッションシェア損失率（予算）	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search top impression share (budget)
SEARCH_RANK_LOST_TOP_IMPRESSION_SHARE	official_metric	ページ上部のインプレッションシェア損失率（ランク）	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Search top lost impression share (rank)
SEARCH_CLICK_SHARE	official_metric	クリックシェア	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (DOUBLE)	Click share
BUDGET_ID	official_attribute	共有予算ID	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (LONG)	Shared budget ID
BUDGET_NAME	official_attribute	共有予算名	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (STRING)	Shared budget name
AB_TEST_USAGE	official_attribute	A/Bテスト利用	Yahoo!広告 v19 ReportDefinitionService YSS_CAMPAIGN (ENUM)	A/B test usage
ADGROUP_ID	official_attribute	広告グループID	Yahoo!広告 v19 ReportDefinitionService YSS_ADGROUP (LONG)	Ad group ID
ADGROUP_NAME	official_attribute	広告グループ名	Yahoo!広告 v19 ReportDefinitionService YSS_ADGROUP (STRING)	Ad group name
ADGROUP_DISTRIBUTION_SETTINGS	official_attribute	配信設定	Yahoo!広告 v19 ReportDefinitionService YSS_ADGROUP (ENUM)	Distribution Settings
ADGROUP_BID	official_attribute	広告グループの入札価格	Yahoo!広告 v19 ReportDefinitionService YSS_ADGROUP (LONG)	Ad group bid
ADGROUP_TRACKING_ID	official_attribute	広告グループトラッキングID	Yahoo!広告 v19 ReportDefinitionService YSS_ADGROUP (LONG)	Ad group tracking ID
AD_ID	official_attribute	広告ID	Yahoo!広告 v19 ReportDefinitionService YSS_AD (LONG)	Ad ID
AD_NAME	official_attribute	広告名	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Ad Name
DISPLAY_URL	official_attribute	表示URL	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Display URL
DESTINATION_URL	official_attribute	リンク先URL	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Destination URL
AD_TYPE	official_attribute	広告タイプ	Yahoo!広告 v19 ReportDefinitionService YSS_AD (ENUM)	Ad Type
AD_DISTRIBUTION_SETTINGS	official_attribute	配信設定	Yahoo!広告 v19 ReportDefinitionService YSS_AD (ENUM)	Distribution Settings
AD_EDITORIAL_STATUS	official_attribute	審査状況	Yahoo!広告 v19 ReportDefinitionService YSS_AD (ENUM)	Editorial Status
DESCRIPTION1	official_attribute	説明文1	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Description 1
DESCRIPTION2	official_attribute	説明文2	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Description 2
DEVICE_PREFERENCE	official_attribute	優先デバイス	Yahoo!広告 v19 ReportDefinitionService YSS_AD (ENUM)	Focus Device
FINAL_URL	official_attribute	最終リンク先URL	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Final URL
FINAL_URL_SMARTPHONE	official_attribute	スマートフォン向けURL	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Smartphone final URL
AD_TRACKING_ID	official_attribute	広告トラッキングID	Yahoo!広告 v19 ReportDefinitionService YSS_AD (LONG)	Ad tracking ID
AD_KEYWORD_ID	official_report_field	キーワードID	Yahoo!広告 v19 ReportDefinitionService YSS_AD (LONG)	Keyword ID
TITLE1	official_attribute	タイトル1	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Title1
TITLE2	official_attribute	タイトル2	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Title2
TITLE3	official_attribute	タイトル3	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Title3
DIRECTORY1	official_attribute	ディレクトリ1	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Directory1
DIRECTORY2	official_attribute	ディレクトリ2	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Directory2
ASSET_TITLE1	official_attribute	アセット（タイトル1）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title1)
ASSET_TITLE2	official_attribute	アセット（タイトル2）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title2)
ASSET_TITLE3	official_attribute	アセット（タイトル3）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title3)
ASSET_TITLE4	official_attribute	アセット（タイトル4）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title4)
ASSET_TITLE5	official_attribute	アセット（タイトル5）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title5)
ASSET_TITLE6	official_attribute	アセット（タイトル6）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title6)
ASSET_TITLE7	official_attribute	アセット（タイトル7）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title7)
ASSET_TITLE8	official_attribute	アセット（タイトル8）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title8)
ASSET_TITLE9	official_attribute	アセット（タイトル9）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title9)
ASSET_TITLE10	official_attribute	アセット（タイトル10）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title10)
ASSET_TITLE11	official_attribute	アセット（タイトル11）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title11)
ASSET_TITLE12	official_attribute	アセット（タイトル12）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title12)
ASSET_TITLE13	official_attribute	アセット（タイトル13）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title13)
ASSET_TITLE14	official_attribute	アセット（タイトル14）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title14)
ASSET_TITLE15	official_attribute	アセット（タイトル15）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (title15)
ASSET_DESCRIPTION1	official_attribute	アセット（説明文1）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (description1)
ASSET_DESCRIPTION2	official_attribute	アセット（説明文2）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (description2)
ASSET_DESCRIPTION3	official_attribute	アセット（説明文3）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (description3)
ASSET_DESCRIPTION4	official_attribute	アセット（説明文4）	Yahoo!広告 v19 ReportDefinitionService YSS_AD (STRING)	Asset (description4)
AD_STRENGTH	official_attribute	広告アセットの充実度	Yahoo!広告 v19 ReportDefinitionService YSS_AD (ENUM)	Ad strength
KEYWORD_ID	official_attribute	キーワードID	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	Keyword ID
CUSTOM_URL	official_attribute	カスタムURL	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (STRING)	Custom URL
KEYWORD	official_attribute	キーワード	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (STRING)	Keyword
KEYWORD_DISTRIBUTION_SETTINGS	official_attribute	配信設定	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	Distribution Settings
KEYWORD_EDITORIAL_STATUS	official_attribute	審査状況	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	Editorial Status
BID	official_attribute	入札価格	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	Bid (JPY)
NEGATIVE_KEYWORD	official_attribute	対象外キーワード	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (STRING)	Negative Keywords
QUALITY_INDEX	official_attribute	品質インデックス	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
FIRST_PAGE_BID_ESTIMATE	official_attribute	1ページ目掲載に必要な入札価格	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
KEYWORD_MATCH_TYPE	official_attribute	マッチタイプ	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	Match Type
TOP_OF_PAGE_BID_ESTIMATE	official_attribute	1ページ目上部掲載に必要な入札価格	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
KEYWORD_TRACKING_ID	official_attribute	キーワードトラッキングID	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	Keyword tracking ID
SYSTEM_SERVING_STATUS	official_attribute	キーワードの状況	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	Keyword status
SEARCH_PREDICTED_CTR	official_attribute	推定クリック値	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
HISTORICAL_QUALITY_SCORE	official_metric	品質インデックス（履歴）	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (LONG)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
HISTORICAL_SEARCH_PREDICTED_CTR	official_metric	推定クリック値（履歴）	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
CREATIVE_QUALITY_SCORE	official_attribute	広告の関連性	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
HISTORICAL_CREATIVE_QUALITY_SCORE	official_metric	広告の関連性（履歴）	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
POST_CLICK_QUALITY_SCORE	official_attribute	ランディングページの利便性	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
HISTORICAL_LANDING_PAGE_QUALITY_SCORE	official_metric	ランディングページの利便性（履歴）	Yahoo!広告 v19 ReportDefinitionService YSS_KEYWORDS (ENUM)	データ取得出来ない場合、値は空文字が設定されます/When the data cannot be retrieved, the value is set to a blank
CAMPAIGN_USER_STATUS	official_attribute	キャンペーン配信設定	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Campaign delivery settings
ADGROUP_USER_STATUS	official_attribute	広告グループ配信設定	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Ad group delivery settings
AD_USER_STATUS	official_attribute	広告配信設定	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Ad delivery settings
PREF_ID	official_report_field	都道府県ID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
PREFECTURE_ID	official_report_field	都道府県ID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Prefecture ID
PREF_NAME	official_report_field	都道府県	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
PREFECTURE	official_report_field	都道府県	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Prefectures
CITY_ID	official_report_field	市区郡ID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	City ID
CITY_NAME	official_report_field	市区郡	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
CITY	official_report_field	市区郡	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	City
WARD_ID	official_report_field	行政区ID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Ward ID
WARD_NAME	official_report_field	行政区	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
WARD	official_report_field	行政区	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Ward
GENDER	official_report_field	性別	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Gender
AGE	official_report_field	年齢	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Age
HOUR	official_report_field	時間	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Hourly
MAIN_MEDIA_FORMAT	official_attribute	メインメディアの形式	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Main media format
MEDIA_ID	official_report_field	メディアID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Media ID
MEDIA_NAME	official_report_field	メディア名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Media Name
MEDIA_FILE_NAME	official_report_field	ファイル名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	File Name
MEDIA_AD_FORMAT	official_report_field	ピクセルサイズ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Pixel Size
AD_TITLE	official_attribute	タイトル	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Title
SEARCHKEYWORD_ID	official_report_field	サーチキーワードID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Search Keyword ID
SEARCHKEYWORD	official_report_field	サーチキーワード	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Search Keyword
CONVERSION_CATEGORY	official_report_field	コンバージョン測定の目的	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Objective of Conversion Tracking
AD_LAYOUT	official_attribute	レイアウト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Layout
CAMPAIGN_LABEL_IDS_JSON	official_attribute	キャンペーンラベルIDリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Campaign label IDs (JSON)
CAMPAIGN_LABELS	official_attribute	キャンペーンラベルリスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Campaign labels
CAMPAIGN_LABELS_JSON	official_attribute	キャンペーンラベルリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Campaign labels (JSON)
ADGROUP_LABEL_IDS_JSON	official_attribute	広告グループラベルIDリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad group label IDs (JSON)
ADGROUP_LABELS	official_attribute	広告グループラベルリスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad group labels
ADGROUP_LABELS_JSON	official_attribute	広告グループラベルリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad group labels (JSON)
AD_LABEL_IDS_JSON	official_attribute	広告ラベルIDリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad label IDs (JSON)
AD_LABELS	official_attribute	広告ラベルリスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad labels
AD_LABELS_JSON	official_attribute	広告ラベルリスト（JSON）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LIST )	Ad labels (JSON)
OS	official_report_field	OS	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	OS
APPLI	official_report_field	ウェブ/アプリ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Web/App
APP_ID	official_attribute	アプリID/パッケージ名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	App ID/Package name
APP_NAME	official_attribute	アプリ名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	App Name
APP_OS	official_attribute	アプリOS	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	App OS
CAMPAIGN_GOALS	official_report_field	キャンペーン目的	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Campaign goals
CAMPAIGN_SUBTYPE	official_attribute	キャンペーンサブタイプ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Campaign subtype
CAMPAIGN_BUYING_TYPE	official_attribute	キャンペーン購入タイプ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Campaign buying type
DEAL_TYPE	official_attribute	商品種別	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Package type
DESTINATION_URL_CAMPAIGN_BANNER	official_attribute	リンク先URL（キャンペーンバナー）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Destination URL (campaign banner)
PACKAGE_NAME	official_attribute	商品名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Package name
CLICK	official_metric	クリック数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
AVG_DELIVER_RANK	official_metric	平均掲載順位	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. position
VIEWABLE_IMPS	official_metric	ビューアブルインプレッション数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Viewable impressions
AVG_CPV	official_metric	平均CPV	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. CPV
VIDEO_VIEWS_TO_25	official_metric	動画の25%再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	25% video views
VIDEO_VIEWS_TO_50	official_metric	動画の50%再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	50% video views
VIDEO_VIEWS_TO_75	official_metric	動画の75%再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	75% video views
VIDEO_VIEWS_TO_95	official_metric	動画の95%再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	95% video views
VIDEO_VIEWS_TO_100	official_metric	動画の100%再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	100% video views
AVG_PERCENT_VIDEO_VIEWED	official_metric	動画の平均再生率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. video view rate
AVG_DURATION_VIDEO_VIEWED	official_metric	動画の平均再生時間（秒）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. duration of video viewed
VIDEO_VIEWS	official_metric	動画の再生開始数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Video views
PAID_VIDEO_VIEWS	official_metric	課金が発生した動画再生数（CPV課金キャンペーンのみ）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Paid video views (CPV)
PAID_VIDEO_VIEW_RATE	official_metric	課金が発生した動画再生率（CPV課金キャンペーンのみ）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Paid video view rate (CPV)
VIDEO_VIEWS_TO_3_SEC	official_metric	動画の3秒再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	3 sec video views
CONVERSIONS_VIA_AD_CLICK	official_metric	コンバージョン数（クリック経由）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversions (via click)
CONVERSION_RATE_VIA_AD_CLICK	official_metric	コンバージョン率（クリック経由）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conv. rate (via click)
COST_PER_CONV_VIA_AD_CLICK	official_metric	コスト/コンバージョン数（クリック経由）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Cost/conv. (via click)
CONV_VALUE_VIA_AD_CLICK	official_metric	コンバージョンの価値（クリック経由）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conv. value (via click)
VALUE_PER_CONV_VIA_AD_CLICK	official_metric	コンバージョンの価値（クリック経由）/コンバージョン数（クリック経由）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conv. value (via click)/conv. (via click)
CONV_VALUE_VIA_AD_CLICK_PER_COST	official_metric	コンバージョンの価値（クリック経由）/コスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conv. value (via click)/cost
AVG_CPM	official_metric	平均CPM	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. CPM
AVG_VCPM	official_metric	平均vCPM	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Avg. vCPM
MEASURED_IMPS	official_metric	メジャードインプレッション数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Measured impressions
VIEWABLE_CLICK	official_metric	ビューアブルクリック数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	このフィールドは非推奨です。将来削除される予定です。 / This field is deprecated and will be removed in a future version.
VIEWABLE_CLICKS	official_metric	ビューアブルクリック数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Viewable clicks
MEASURED_IMPS_RATE	official_metric	メジャードインプレッション測定率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Measured impression rate
VIEWABLE_IMPS_RATE	official_metric	ビューアブルインプレッション率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Viewable impression rate
VIEWABLE_CLICK_RATE	official_metric	ビューアブルクリック率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Viewable CTR
VIDEO_VIEWS_TO_10_SEC	official_metric	動画の10秒再生数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	10 sec video views
IMPRESSION_SHARE_BUDGET_LOSS	official_metric	インプレッションシェア損失率（予算）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	このフィールドは非推奨です。将来削除される予定です。データを取得できない場合、空の値が設定されます。 / This field is deprecated and will be removed in a future version. When failed to acquire data, a blank will be set.
IMPRESSION_SHARE_RANK_LOSS	official_metric	インプレッションシェア損失率（ランク）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	このフィールドは非推奨です。将来削除される予定です。データを取得できない場合、空の値が設定されます。 / This field is deprecated and will be removed in a future version. When failed to acquire data, a blank will be set.
RANK_LOST_IMPRESSION_SHARE	official_metric	インプレッションシェア損失率（ランク）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	データを取得できない場合、空の値が設定されます。 / When failed to acquire data, a blank will be set.
CAMPAIGN_LIFETIME_BUDGET	official_attribute	通期予算	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Lifetime budget
SPECIAL_PRODUCT_TYPE	official_attribute	キャンペーン掲載タイプ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Campaign delivery type
CONV_VALUE_VIA_VIEW_THROUGH	official_metric	ビュースルーコンバージョン数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	View-through conversions
VIDEO_VIEW_THROUGH_RATE	official_metric	動画の再生完了率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Video view through rate
CONVERSION_ID	official_attribute	コンバージョンID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Conversion ID
CONTENT_KEYWORD_ID	official_report_field	コンテンツキーワードID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Content keyword ID
CONTENT_KEYWORD	official_report_field	コンテンツキーワード	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Content keyword
CONVERSION_GROUP_NAME	official_attribute	コンバージョングループ名	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Conversion group name
CONVERSION_GROUP_ID	official_attribute	コンバージョングループID	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversion group ID
RADIUS_TARGET	official_report_field	半径指定範囲	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Target radius
RADIUS_DISTANCE	official_report_field	指定地点からの距離	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Distance from target location
MATERIAL_VIEWABLE_IMPS	official_metric	パネル別ビューアブルインプレッション数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Viewable impressions per panel
MATERIAL_VIEWABLE_CLICK_RATE	official_metric	パネル別ビューアブルクリック率	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Viewable CTR per panel
RESPONSIVE_ADS_TYPE	official_attribute	レスポンシブ広告入稿タイプ	Yahoo!広告 v19 ReportDefinitionService YDA_AD (STRING)	Responsive ads type
MMP_INSTALLS	official_metric	インストール数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Installs
MMP_INSTALLS_VIA_CLICK	official_metric	インストール数（クリック）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Installs (click)
MMP_POST_INSTALL_CONVERSIONS	official_metric	インストール後のコンバージョン数	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversions after install
MMP_POST_INSTALL_CONVERSIONS_VIA_CLICK	official_metric	インストール後のコンバージョン数（クリック）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversions after install (click)
MMP_POST_INSTALL_ALL_CONVERSIONS	official_metric	インストール後のコンバージョン数（全て）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversions after install (all)
MMP_POST_INSTALL_ALL_CONVERSIONS_VIA_CLICK	official_metric	インストール後のコンバージョン数（クリック）（全て）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (LONG)	Conversions after install (click) (all)
MMP_POST_INSTALL_CONV_VALUE	official_metric	インストール後のコンバージョン価値	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value after install
MMP_POST_INSTALL_CONV_VALUE_VIA_CLICK	official_metric	インストール後のコンバージョン価値（クリック）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value after install (click)
MMP_POST_INSTALL_ALL_CONV_VALUE	official_metric	インストール後のコンバージョン価値（全て）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value after install (all)
MMP_POST_INSTALL_ALL_CONV_VALUE_VIA_CLICK	official_metric	インストール後のコンバージョン価値（クリック）（全て）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value after install (click) (all)
MMP_COST_PER_INSTALL	official_metric	インストール単価	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Cost per install
MMP_COST_PER_INSTALL_VIA_CLICK	official_metric	インストール単価（クリック）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Cost per install (click)
MMP_COST_PER_POST_INSTALL_CONV	official_metric	インストール後のコンバージョン単価	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	CPA after install
MMP_COST_PER_POST_INSTALL_CONV_VIA_CLICK	official_metric	インストール後のコンバージョン単価（クリック）	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	CPA after install (click)
MMP_POST_INSTALL_CONV_VALUE_PER_COST	official_metric	インストール後のコンバージョン価値/コスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value after install/cost
MMP_POST_INSTALL_CONV_VALUE_VIA_CLICK_PER_COST	official_metric	インストール後のコンバージョン価値（クリック）/コスト	Yahoo!広告 v19 ReportDefinitionService YDA_AD (DOUBLE)	Conversion value (click) after install/cost

Microsoft広告

広告 / Microsoft OAuth

提供中

Microsoft Advertisingの費用、表示回数、クリック、CV、売上、キャンペーン、広告グループ、キーワード実績を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_microsoft_ads_accounts	なし	account_id / name / currency	接続済みMicrosoft広告アカウントを一覧化する
microsoft_ads_performance_summary	start_date, end_date, account_id	spend / clicks / impressions / conversions / revenue	Microsoft広告の日次実績を取得する
run_microsoft_ads_report	report_type, start_date, end_date, account_id, limit	rows / spend / revenue	キャンペーン・広告グループ・キーワード別に取得する

フィールド

ID	型	表示名	媒体側API名	説明
AbsoluteTopImpressionRatePercent	official_metric	Absolute Top Impression Rate Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	How often your ad was in the first position of all results, as a percentage of your total impressions. A higher number indicates your ad is frequently showing in the best ad position. The value of this column is empty if the data is not available. Neither Hou…
AbsoluteTopImpressionShareLostToBudgetPercent	official_metric	Absolute Top Impression Share Lost To Budget Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of how often your ad missed showing in the very top ad position, above search results, due to insufficient budget. This indicates where increasing your budget might improve your chances at the top ad position, which is more likely to…
AbsoluteTopImpressionShareLostToRankPercent	official_metric	Absolute Top Impression Share Lost To Rank Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of how often poor ad rank kept your ad from showing in the first ad position at the top of search results. Use this data to help you assess reasons your ads are missing out on the top ad position, which is more likely to win clicks an…
AbsoluteTopImpressionSharePercent	official_metric	Absolute Top Impression Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of times your ad was in the first position of all results, out of the estimated number of first position impressions you were eligible to receive. A low number means your ads are less likely to win clicks and conversions, because they…
AccountId	official_attribute	Account Id	Microsoft Advertising v13 CampaignPerformanceReportColumn	The Microsoft Advertising assigned identifier of an account.
AccountName	official_attribute	Account Name	Microsoft Advertising v13 CampaignPerformanceReportColumn	The account name.
AccountNumber	official_attribute	Account Number	Microsoft Advertising v13 CampaignPerformanceReportColumn	The Microsoft Advertising assigned number of an account.
AccountStatus	official_attribute	Account Status	Microsoft Advertising v13 CampaignPerformanceReportColumn	The account status.
AdDistribution	official_attribute	Ad Distribution	Microsoft Advertising v13 CampaignPerformanceReportColumn	The network where you want your ads to show. This can be the entire Microsoft Advertising Network, Microsoft sites and select traffic, cross-network traffic, or only partner traffic (this network type is deprecated as of July 2024).
AdRelevance	official_attribute	Ad Relevance	Microsoft Advertising v13 CampaignPerformanceReportColumn	How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.…
AllConversionRate	official_metric	All Conversion Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%). The formula for calculating the conversion ra…
AllConversions	official_metric	All Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure…
AllConversionsQualified	official_metric	All Conversions Qualified	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure…
AllCostPerConversion	official_metric	All Cost Per Conversion	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). Only ads in campaigns that enable conversion tracking contribute to the conversion number, so unless all campaigns in the account enable conversion tracking…
AllReturnOnAdSpend	official_metric	All Return On Ad Spend	Microsoft Advertising v13 CampaignPerformanceReportColumn	The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). Data will be excluded from the ReturnOnAdSpend report column for any conversion goal with the ExcludeFromBidding property set to true. The AllReturnOnAdSpend column will…
AllRevenue	official_metric	All Revenue	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue optionally reported by the advertiser as a result of conversions. Data will be excluded from the Revenue report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenue column will include data for all conver…
AllRevenuePerConversion	official_metric	All Revenue Per Conversion	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). Data will be excluded from the RevenuePerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllR…
AppInstalls	official_metric	App Installs	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times customers install apps through your ads.
Assists	official_attribute	Assists	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. An ad is considered to have assisted the conversion if it was clicked before the most recently clicked ad that was credited with the conver…
AudienceImpressionLostToBudgetPercent	official_metric	Audience Impression Lost To Budget Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network. If this number is high, you may want to increase your budget. The value of this column is empty if the data is not available. If you try to include this…
AudienceImpressionLostToRankPercent	official_metric	Audience Impression Lost To Rank Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of impression share you lost due to low rank on the Microsoft Audience Network. Ad rank determines your ad position and whether your ad is able to show at all. It's calculated using your bid, quality, and the expected impact of ad formats. The…
AudienceImpressionSharePercent	official_metric	Audience Impression Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network. Use this to compare your share of impressions to the impression share of advertisers competing against you. Example: Out…
AverageCPV	official_attribute	Average CPV	Microsoft Advertising v13 CampaignPerformanceReportColumn	Average total spend divided by video views.
AverageCpc	official_metric	Average Cpc	Microsoft Advertising v13 CampaignPerformanceReportColumn	The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CP…
AverageCpm	official_metric	Average Cpm	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total advertising cost divided by the number of impressions (in thousands).<br/ In Latin, mille means a thousand. Also, sometimes called average cost per thousand (CPT). This is a standard advertising industry performance metric that we calculate based on…
AveragePosition	official_attribute	Average Position	Microsoft Advertising v13 CampaignPerformanceReportColumn	The average position of the ad on a webpage. This column is deprecated as of March 31st, 2021. Going forward, performance reports will return average position of "0" (zero). Historical average position data for time periods prior to the deprecation date will…
AverageWatchTimePerImpression	official_metric	Average Watch Time Per Impression	Microsoft Advertising v13 CampaignPerformanceReportColumn	Total watch time, in milliseconds, divided by the number of impressions.
AverageWatchTimePerVideoView	official_metric	Average Watch Time Per Video View	Microsoft Advertising v13 CampaignPerformanceReportColumn	Total watch time divided by the number of video views.
BaseCampaignId	official_attribute	Base Campaign Id	Microsoft Advertising v13 CampaignPerformanceReportColumn	The Microsoft Advertising assigned identifier of an experiment campaign. This will be the same value as the CampaignId if the campaign is not an experiment.
BidMatchType	official_attribute	Bid Match Type	Microsoft Advertising v13 CampaignPerformanceReportColumn	The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies . The possible values are Broad , Exact ,…
BudgetAssociationStatus	official_attribute	Budget Association Status	Microsoft Advertising v13 CampaignPerformanceReportColumn	Indicates whether or not the campaign is currently spending from the budget mentioned in the BudgetName column. The possible values are Current and Ended .
BudgetName	official_attribute	Budget Name	Microsoft Advertising v13 CampaignPerformanceReportColumn	The name of the budget. This column will be empty for unshared budgets.
BudgetStatus	official_attribute	Budget Status	Microsoft Advertising v13 CampaignPerformanceReportColumn	The budget status. The possible values are Active and Deleted . This column will be empty for unshared budgets.
CPI	official_attribute	CPI	Microsoft Advertising v13 CampaignPerformanceReportColumn	Cost per install. The average amount of money you're charged for each app install.
CPP	official_attribute	CPP	Microsoft Advertising v13 CampaignPerformanceReportColumn	Cost per in-app purchase. The average amount of money you're charged for each in-app purchase.
CPS	official_attribute	CPS	Microsoft Advertising v13 CampaignPerformanceReportColumn	Cost per in-app subscription. The average amount of money you're charged for each app subscription.
CampaignId	official_attribute	Campaign Id	Microsoft Advertising v13 CampaignPerformanceReportColumn	The Microsoft Advertising assigned identifier of a campaign.
CampaignLabels	official_attribute	Campaign Labels	Microsoft Advertising v13 CampaignPerformanceReportColumn	The labels applied to the campaign. Labels are delimited by a semicolon (;) in the report download.
CampaignName	official_attribute	Campaign Name	Microsoft Advertising v13 CampaignPerformanceReportColumn	The campaign name.
CampaignStatus	official_attribute	Campaign Status	Microsoft Advertising v13 CampaignPerformanceReportColumn	The campaign status.
CampaignType	official_attribute	Campaign Type	Microsoft Advertising v13 CampaignPerformanceReportColumn	The campaign type. Possible values include Audience , Dynamic search , Performance max , Search & content , and Shopping .
ClickSharePercent	official_metric	Click Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. You can use this performance metric to see where your growth opportunites are. For example, your click share percent is 30%…
Clicks	official_metric	Clicks	Microsoft Advertising v13 CampaignPerformanceReportColumn	Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers). For more information, see…
CompletedVideoViews	official_metric	Completed Video Views	Microsoft Advertising v13 CampaignPerformanceReportColumn	Number of times a person watched the entire video to completion.
ConversionDelay	official_metric	Conversion Delay	Microsoft Advertising v13 CampaignPerformanceReportColumn	The time gap between when a user clicks on an ad and when they complete a desired action, such as making a purchase, signing up, or downloading an app.
ConversionRate	official_metric	Conversion Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%). The formula for calculating the conversion ra…
Conversions	official_metric	Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure…
ConversionsQualified	official_metric	Conversions Qualified	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure…
CostPerAssist	official_metric	Cost Per Assist	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per assist. The formula for calculating the cost per assist is (Spend / Assists) .
CostPerConversion	official_metric	Cost Per Conversion	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). Only ads in campaigns that enable conversion tracking contribute to the conversion number, so unless all campaigns in the account enable conversion tracking…
CostPerDownload	official_metric	Cost Per Download	Microsoft Advertising v13 CampaignPerformanceReportColumn	The average amount you're charged each time your ad is downloaded. The total cost of all downloads on an ad, divided by the number of downloads during a specific period.
CostPerInstall	official_metric	Cost Per Install	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per install. The formula for calculating the cost per install is (Spend / Installs)
CostPerSale	official_metric	Cost Per Sale	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per sale. The formula for calculating the cost per sale is (Spend / Sales)
Ctr	official_metric	Ctr	Microsoft Advertising v13 CampaignPerformanceReportColumn	The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%). The formula for calculating CTR is (Cli…
CurrencyCode	official_attribute	Currency Code	Microsoft Advertising v13 CampaignPerformanceReportColumn	The account currency type. For possible values, see Currencies .
CustomParameters	official_attribute	Custom Parameters	Microsoft Advertising v13 CampaignPerformanceReportColumn	The current set of custom parameters for the campaign. Each custom parameter is a key and value pair. The list of custom parameters is semicolon-delimited and each key is enclosed by braces and a leading underscore, for example {_key1}=value1;{_key2}=value2 .
CustomerId	official_attribute	Customer Id	Microsoft Advertising v13 CampaignPerformanceReportColumn	The Microsoft Advertising assigned identifier of a customer.
CustomerName	official_attribute	Customer Name	Microsoft Advertising v13 CampaignPerformanceReportColumn	The customer name.
DeliveredMatchType	official_attribute	Delivered Match Type	Microsoft Advertising v13 CampaignPerformanceReportColumn	The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies . The possible values are Broad , Exa…
DeviceOS	official_attribute	Device OS	Microsoft Advertising v13 CampaignPerformanceReportColumn	The operating system of the device reported in the DeviceType column. The possible values include Android , Blackberry , iOS , Other , Unknown , and Windows . If the operating system of the device cannot be determined or is not one of the operating systems th…
DeviceType	official_attribute	Device Type	Microsoft Advertising v13 CampaignPerformanceReportColumn	The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer , Smartphone , Tablet , and Unknown .
Downloads	official_attribute	Downloads	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times customers download apps through your ads.
ExactMatchImpressionSharePercent	official_metric	Exact Match Impression Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive. Reports on exact match impression share highlight how your keyw…
ExpectedCtr	official_metric	Expected Ctr	Microsoft Advertising v13 CampaignPerformanceReportColumn	How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate. This metric tells you if a keyword is underperforming and causing…
FinalUrlSuffix	official_attribute	Final Url Suffix	Microsoft Advertising v13 CampaignPerformanceReportColumn	A place in your final URL where you can add parameters that will be attached to the end of your landing page URL.
Goal	official_attribute	Goal	Microsoft Advertising v13 CampaignPerformanceReportColumn	The name of the goal you set for the conversions you want, meaning actions customers take after clicking your ad.
GoalType	official_attribute	Goal Type	Microsoft Advertising v13 CampaignPerformanceReportColumn	The type of conversion goal. Possible values include AppInstall , Duration , Event , InStoreTransaction , OfflineConversion , PagesViewedPerVisit , and Url .
HistoricalAdRelevance	official_attribute	Historical Ad Relevance	Microsoft Advertising v13 CampaignPerformanceReportColumn	Historical average of ad relevance scores back as far as 18 months from the current date. This score may vary from the score in the AdRelevance column, which is the current score and same value for each day in the time period.
HistoricalExpectedCtr	official_metric	Historical Expected Ctr	Microsoft Advertising v13 CampaignPerformanceReportColumn	Historical average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period. The score i…
HistoricalLandingPageExperience	official_attribute	Historical Landing Page Experience	Microsoft Advertising v13 CampaignPerformanceReportColumn	Historical average of landing page experience scores back as far as 18 months from the current date. This score may vary from the score in the LandingPageExperience column, which is the current score and same value for each day in the time period. The score i…
HistoricalQualityScore	official_attribute	Historical Quality Score	Microsoft Advertising v13 CampaignPerformanceReportColumn	The historical quality score for each row is the value that was calculated for quality score on that date. Use The historical quality score to find out how the quality score may have changed over time. For example, if you specify a time period that spans thre…
ImpressionLostToBudgetPercent	official_metric	Impression Lost To Budget Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available. If you try to include this column with Hourly or HourOfDay aggregation the service…
ImpressionLostToRankAggPercent	official_metric	Impression Lost To Rank Agg Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available. If you try to include this column with Hourly or HourOfDay aggregation the service will return…
ImpressionSharePercent	official_metric	Impression Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of impressions, out of the total available impressions in the market you were targeting. Example: Out of estimated 59,000 impressions that occurred on this day in your targeted market, you got only about 2,300, or 3%. The value of thi…
Impressions	official_metric	Impressions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Installs	official_metric	Installs	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total number of installs.
LandingPageExperience	official_attribute	Landing Page Experience	Microsoft Advertising v13 CampaignPerformanceReportColumn	An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website. A score of 3 is Above Avera…
LowQualityClicks	official_metric	Low Quality Clicks	Microsoft Advertising v13 CampaignPerformanceReportColumn	Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks. For more information, see Microsoft Advertising click measurement: description of methodology . Note : In the Microsoft Advertising reporting UI, LowQualityClicks…
LowQualityClicksPercent	official_metric	Low Quality Clicks Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The low-quality clicks as a percentage. The formula for calculating the low quality clicks percentage is (LowQualityClicks / (Clicks + LowQualityClicks )) x 100 .
LowQualityConversionRate	official_metric	Low Quality Conversion Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The low-quality conversion rate as a percentage. The formula for calculating the conversion rate is (LowQualityConversions / LowQualityClicks) x 100.
LowQualityConversions	official_metric	Low Quality Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions that originate from low-quality clicks. This column is deprecated as of March 31st, 2022, so you should use the LowQualityConversionsQualified column instead. Going forward, performance reports will return "0" (zero) in this column.…
LowQualityConversionsQualified	official_metric	Low Quality Conversions Qualified	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of conversions that originate from low-quality clicks. You should expect the data type as double whether or not there are partial externally attributed offline conversions. Not everyone has this feature yet. If you don't, don't worry - it's coming…
LowQualityGeneralClicks	official_metric	Low Quality General Clicks	Microsoft Advertising v13 CampaignPerformanceReportColumn	Clicks that are filtered by general methods, such as deny lists and activity-based detection, and that exhibit a low likelihood of commercial intent. You are not billed for these clicks. For more information, see Microsoft Advertising click measurement: descr…
LowQualityImpressions	official_metric	Low Quality Impressions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent	official_metric	Low Quality Impressions Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The low-quality impressions as a percentage. The formula for calculating the percentage is (LowQualityImpressions / (Impressions + LowQualityImpressions )) x 100 .
LowQualitySophisticatedClicks	official_metric	Low Quality Sophisticated Clicks	Microsoft Advertising v13 CampaignPerformanceReportColumn	Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks. For more information, see Microsoft Advertising click measurement: description of methodology . Note : In the Microsoft Advertising reporting UI, LowQualitySophi…
Network	official_attribute	Network	Microsoft Advertising v13 CampaignPerformanceReportColumn	The entire Microsoft Advertising Network made up of Microsoft sites and select traffic, cross-network traffic, and only partner traffic (this network type is deprecated as of July 2024). Use this data to make the best decision on network selection for your ad…
NewCustomerCPA	official_metric	New Customer CPA	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost of acquiring a new customer, calculated by dividing the total cost of your ads by the number of new customer conversions. This column is deprecated as of August 2025. Going forward, performance reports will return empty in this column. Historical dat…
NewCustomerConversionRate	official_metric	New Customer Conversion Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of new customer sessions that result in a conversion. Note : This column is deprecated as of August 2025. Going forward, performance reports will return empty in this column. Historical data for time periods prior to the deprecation date will s…
NewCustomerConversions	official_metric	New Customer Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total number of new customers who completed a desired action, such as making a purchase, after clicking on your ad.
NewCustomerCount	official_attribute	New Customer Count	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of new customers who complete an action, such as making a purchase, after clicking your ad.
NewCustomerReturnOnAdSpend	official_metric	New Customer Return On Ad Spend	Microsoft Advertising v13 CampaignPerformanceReportColumn	The amount of revenue you generate from new customers for every dollar you spend on advertising, calculated by dividing the total revenue from new customers by the total cost of your ads. This column is deprecated as of August 2025. Going forward, performance…
NewCustomerRevenue	official_metric	New Customer Revenue	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total value of new customer conversions, calculated by summing the value of each new customer conversion.
NewCustomerSpend	official_metric	New Customer Spend	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total spend of new customers, calculated by summing the spend of each new customer.
PhoneCalls	official_attribute	Phone Calls	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of total calls to the tracked phone number that showed with your ad.
PhoneImpressions	official_metric	Phone Impressions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times your tracked number was shown on all devices.
PostClickDownloadRate	official_metric	Post Click Download Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The post-click download rate as a percentage. The number of downloads, divided by the total number of ad clicks. For example, if the ads in your campaign received 300 clicks and four downloads, the download rate would be 1.33%.
PostClickInstallRate	official_metric	Post Click Install Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The post-click install rate as a percentage. The number of installs, divided by the total number of clicks. For example, if the ads in your campaign received 300 clicks and four installs, the rate would be 1.33%.
PostInstallPurchaseRate	official_metric	Post Install Purchase Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The post-install purchase rate as a percentage. The number of in-app purchases, divided by the total number of installs. For example, if the ads in your campaign received 300 installs and four in-app purchases, the install rate would be 1.33%.
PostInstallSubscriptionRate	official_metric	Post Install Subscription Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The post-install subscription rate as a percentage. The number of subscriptions, divided by the total number of installs. For example, if the ads in your campaign receive 300 installs and four subscriptions, the install rate would be 1.33%.
Ptr	official_attribute	Ptr	Microsoft Advertising v13 CampaignPerformanceReportColumn	The phone-through rate (Ptr). The formula for calculating the Ptr is (PhoneCalls / PhoneImpressions) x 100 .
Purchases	official_attribute	Purchases	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times customers use your ads to make a purchase in your app.
QualityScore	official_attribute	Quality Score	Microsoft Advertising v13 CampaignPerformanceReportColumn	The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms. The quality score is calculated by Microsoft Advertising using the ExpectedCtr , AdRelevance…
RelativeCtr	official_metric	Relative Ctr	Microsoft Advertising v13 CampaignPerformanceReportColumn	Your click-through rate divided by the average click-through rate of all ads that appear in the same sections of websites that show your ads. Relative CTR can help you understand campaign and ad group performance, particularly if you have little or no convers…
ReturnOnAdSpend	official_metric	Return On Ad Spend	Microsoft Advertising v13 CampaignPerformanceReportColumn	The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). Data will be excluded from the ReturnOnAdSpend report column for any conversion goal with the ExcludeFromBidding property set to true. The AllReturnOnAdSpend column will…
Revenue	official_metric	Revenue	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue optionally reported by the advertiser as a result of conversions. Data will be excluded from the Revenue report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenue column will include data for all conver…
RevenuePerAssist	official_metric	Revenue Per Assist	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists) .
RevenuePerConversion	official_metric	Revenue Per Conversion	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). Data will be excluded from the RevenuePerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllR…
RevenuePerInstall	official_metric	Revenue Per Install	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue per install. The formula for calculating the revenue per install is (Revenue / Installs)
RevenuePerSale	official_metric	Revenue Per Sale	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue per sale. The formula for calculating the revenue per sale is (Revenue / Sales)
Sales	official_attribute	Sales	Microsoft Advertising v13 CampaignPerformanceReportColumn	The total number of sales.
Spend	official_metric	Spend	Microsoft Advertising v13 CampaignPerformanceReportColumn	The cost per click (CPC) summed for each click.
Subscriptions	official_attribute	Subscriptions	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times customers use your ads to purchase a subscription in your game.
TimePeriod	official_attribute	Time Period	Microsoft Advertising v13 CampaignPerformanceReportColumn	The time period of each report row. You may not include this column if the Aggregation element of the request object is set to Summary. For more information, see Time Period Column .
TopImpressionRatePercent	official_metric	Top Impression Rate Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of times your ad showed in the mainline, the top placement where ads appear above the search results, out of your total impressions. This indicates how changes in ad position can impact performance. The value of this column is empty if the data…
TopImpressionShareLostToBudgetPercent	official_metric	Top Impression Share Lost To Budget Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The estimated percentage of mainline impressions, where ads appear above the search results, that were lost due to insufficient budget. This indicates where increasing your budget might help improve ad position. The value of this column is empty if the data i…
TopImpressionShareLostToRankPercent	official_metric	Top Impression Share Lost To Rank Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	A percentage estimate of how often poor ad rank kept your ad from showing in the mainline, the top ad placements above the search results. Use this metric to help you assess why your ads are missing out on the best ad positions. Ad rank determines where your…
TopImpressionSharePercent	official_metric	Top Impression Share Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The percentage of impressions for your ad in the mainline, the top ad placements above the search results, out of the estimated number of mainline impressions you were eligible to receive. A lower number indicates there might be something about your ad's elig…
TopVsOther	official_attribute	Top Vs Other	Microsoft Advertising v13 CampaignPerformanceReportColumn	Indicates whether the ad impression appeared in a top position or elsewhere. The possible values include AOL search - Top, AOL search - Other, Audience network, Bing and Yahoo! search - Top, Bing and Yahoo! search - Other, Syndicated search partners - Top, Sy…
TotalWatchTimeInMS	official_attribute	Total Watch Time In MS	Microsoft Advertising v13 CampaignPerformanceReportColumn	Total amount of time a person spent watching the video in milliseconds.
TrackingTemplate	official_attribute	Tracking Template	Microsoft Advertising v13 CampaignPerformanceReportColumn	The current tracking template for the campaign.
UnknownCustomerConversions	official_metric	Unknown Customer Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	A customer conversion that doesn't have enough data to determine if the customer is a new or existing customer.
UnknownCustomerRevenue	official_metric	Unknown Customer Revenue	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue from unknown customer conversions.
VideoCompletionRate	official_metric	Video Completion Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of completed video views divided by the total number of impressions, multiplied by 100.
VideoViews	official_metric	Video Views	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times the video was played and watched for at least two continuous seconds with more than 50% of the screen in view.
VideoViewsAt25Percent	official_metric	Video Views At25 Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times a person completed at least 25% of a video.
VideoViewsAt50Percent	official_metric	Video Views At50 Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times a person completed at least 50% of a video.
VideoViewsAt75Percent	official_metric	Video Views At75 Percent	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of times a person completed at least 75% of a video.
ViewThroughConversions	official_metric	View Through Conversions	Microsoft Advertising v13 CampaignPerformanceReportColumn	View-through conversions are conversions that people make after they have seen your ad, even though they did not click the ad. View-through conversions don't have a click associated but do have an impression associated within the advertiser defined conversion…
ViewThroughConversionsQualified	official_metric	View Through Conversions Qualified	Microsoft Advertising v13 CampaignPerformanceReportColumn	View-through conversions are conversions that people make after they have seen your ad, even though they did not click the ad. View-through conversions don't have a click associated but do have an impression associated within the advertiser defined conversion…
ViewThroughRate	official_metric	View Through Rate	Microsoft Advertising v13 CampaignPerformanceReportColumn	The number of video views divided by the number of impressions.
ViewThroughRevenue	official_metric	View Through Revenue	Microsoft Advertising v13 CampaignPerformanceReportColumn	The revenue optionally reported by the advertiser as a result of view-through conversions.
AdGroupId	official_attribute	Ad Group Id	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The Microsoft Advertising assigned identifier of an ad group.
AdGroupLabels	official_attribute	Ad Group Labels	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The labels applied to the ad group. Labels are delimited by a semicolon (;) in the report download.
AdGroupName	official_attribute	Ad Group Name	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The ad group name.
AdGroupType	official_attribute	Ad Group Type	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The ad group type. In a Search campaign, the possible values are "Dynamic" and "Standard." In a DynamicSearchAds campaign, the only possible value is "Dynamic." The field will be empty for other campaign types.
GoalId	official_attribute	Goal Id	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The Microsoft Advertising assigned identifier of a conversion goal.
Language	official_attribute	Language	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The language of the publisher where the ad was shown. For possible values, see the Language column of Ad Languages . The language display name will be provided in the report e.g. English .
Status	official_attribute	Status	Microsoft Advertising v13 AdGroupPerformanceReportColumn	The current ad group status.
AdDescription	official_attribute	Ad Description	Microsoft Advertising v13 AdPerformanceReportColumn	The first ad description that appears below the path in your ad.
AdDescription2	official_attribute	Ad Description2	Microsoft Advertising v13 AdPerformanceReportColumn	The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad.
AdGroupStatus	official_attribute	Ad Group Status	Microsoft Advertising v13 AdPerformanceReportColumn	The ad group status.
AdId	official_attribute	Ad Id	Microsoft Advertising v13 AdPerformanceReportColumn	The Microsoft Advertising assigned identifier of an ad.
AdLabels	official_attribute	Ad Labels	Microsoft Advertising v13 AdPerformanceReportColumn	The labels applied to the ad. Labels are delimited by a semicolon (;) in the report download.
AdStatus	official_attribute	Ad Status	Microsoft Advertising v13 AdPerformanceReportColumn	The ad status.
AdStrength	official_attribute	Ad Strength	Microsoft Advertising v13 AdPerformanceReportColumn	The ad strength score of responsive search ads. Ad strength can be Poor , Average , Good , or Excellent . This score tells you how effective and relevant your responsive search ads are. If you see "pending," it means we are calculating your ad strength based…
AdStrengthActionItems	official_attribute	Ad Strength Action Items	Microsoft Advertising v13 AdPerformanceReportColumn	The suggestion based on ad strength of your responsive search ads. To help ensure that you maximize ad performance and don't miss out on opportunities, we provide suggestions for improvement along with your ad strength score.
AdTitle	official_attribute	Ad Title	Microsoft Advertising v13 AdPerformanceReportColumn	The ad title.
AdType	official_attribute	Ad Type	Microsoft Advertising v13 AdPerformanceReportColumn	The ad type.
BusinessName	official_attribute	Business Name	Microsoft Advertising v13 AdPerformanceReportColumn	Depending on your responsive ad's placement, your business's name may appear in your ad. This column only applies to Audience campaigns.
DestinationUrl	official_attribute	Destination Url	Microsoft Advertising v13 AdPerformanceReportColumn	The destination URL attribute of the ad, keyword, or ad group criterion. If the destination URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL after substitution occurs.
DisplayUrl	official_attribute	Display Url	Microsoft Advertising v13 AdPerformanceReportColumn	The ad display URL.
FinalAppUrl	official_attribute	Final App Url	Microsoft Advertising v13 AdPerformanceReportColumn	Reserved for future use.
FinalMobileUrl	official_attribute	Final Mobile Url	Microsoft Advertising v13 AdPerformanceReportColumn	The Final Mobile URL of the ad, keyword, or criterion. Only the first URL in the list is reported. If the URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL before substitution.
FinalUrl	official_attribute	Final Url	Microsoft Advertising v13 AdPerformanceReportColumn	The Final URL of the ad, keyword, or criterion. Only the first URL in the list is reported. If the URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL before substitution.
Headline	official_attribute	Headline	Microsoft Advertising v13 AdPerformanceReportColumn	The shorter of two possible responsive ad headlines for Audience campaigns.
LongHeadline	official_attribute	Long Headline	Microsoft Advertising v13 AdPerformanceReportColumn	The longer of two possible responsive ad headlines for Audience campaigns.
Path1	official_attribute	Path1	Microsoft Advertising v13 AdPerformanceReportColumn	The path 1 attribute of an ad.
Path2	official_attribute	Path2	Microsoft Advertising v13 AdPerformanceReportColumn	The path 2 attribute of an ad.
TitlePart1	official_attribute	Title Part1	Microsoft Advertising v13 AdPerformanceReportColumn	The title part 1 attribute of an ad.
TitlePart2	official_attribute	Title Part2	Microsoft Advertising v13 AdPerformanceReportColumn	The title part 2 attribute of an ad.
TitlePart3	official_attribute	Title Part3	Microsoft Advertising v13 AdPerformanceReportColumn	The title part 3 attribute of an ad.
BidStrategyType	official_metric	Bid Strategy Type	Microsoft Advertising v13 KeywordPerformanceReportColumn	The bid strategy type. Possible values include EnhancedCpc , ManualCpc , MaxClicks , MaxConversions , and TargetCpa . If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values list…
CurrentMaxCpc	official_metric	Current Max Cpc	Microsoft Advertising v13 KeywordPerformanceReportColumn	The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
FirstPageBid	official_attribute	First Page Bid	Microsoft Advertising v13 KeywordPerformanceReportColumn	Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Microsoft Advertising calculates for your ad to be placed on the first page in the search results. These estimates are provided as a reference only. They are aut…
Keyword	official_attribute	Keyword	Microsoft Advertising v13 KeywordPerformanceReportColumn	The keyword text.
KeywordId	official_attribute	Keyword Id	Microsoft Advertising v13 KeywordPerformanceReportColumn	The Microsoft Advertising assigned identifier of a keyword.
KeywordLabels	official_attribute	Keyword Labels	Microsoft Advertising v13 KeywordPerformanceReportColumn	The labels applied to the keyword. Labels are delimited by a semicolon (;) in the report download.
KeywordStatus	official_attribute	Keyword Status	Microsoft Advertising v13 KeywordPerformanceReportColumn	The keyword status.
Mainline1Bid	official_attribute	Mainline1 Bid	Microsoft Advertising v13 KeywordPerformanceReportColumn	Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Microsoft Advertising calculates will place your ad at the top of search results. These estimates are provided as a reference only. They are automatically genera…
MainlineBid	official_attribute	Mainline Bid	Microsoft Advertising v13 KeywordPerformanceReportColumn	Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Microsoft Advertising calculates for your ad to be placed on the first page in the search results. These estimates are provided as a reference only. They are aut…
QualityImpact	official_attribute	Quality Impact	Microsoft Advertising v13 KeywordPerformanceReportColumn	The numeric score that indicates the possible increase in the number of impressions that the keyword could receive if the corresponding QualityScore column would rise above underperforming:0 - Not available. Could be because the keyword is not underperforming…
AdGroupCriterionId	official_attribute	Ad Group Criterion Id	Microsoft Advertising v13 SearchQueryPerformanceReportColumn	The Microsoft Advertising assigned identifier of an ad group criterion.
AssetGroupId	official_attribute	Asset Group Id	Microsoft Advertising v13 SearchQueryPerformanceReportColumn	Reserved.
AssetGroupName	official_attribute	Asset Group Name	Microsoft Advertising v13 SearchQueryPerformanceReportColumn	Reserved.
AssetGroupStatus	official_attribute	Asset Group Status	Microsoft Advertising v13 SearchQueryPerformanceReportColumn	Reserved.
SearchQuery	official_attribute	Search Query	Microsoft Advertising v13 SearchQueryPerformanceReportColumn	The search term used by your potential audience.

Meta広告

広告 / Meta OAuth / API token

準備中

Meta広告の費用、表示回数、リーチ、頻度、クリック、リンククリック、CV種別、CV値、外部クリック、動画視聴系指標を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_meta_ads_accounts	なし	account_id / name	接続済みMeta広告アカウントを一覧化する
meta_ads_performance_summary	start_date, end_date, account_id	spend / reach / clicks / actions / action_values / video	Meta広告の日次実績を取得する
run_meta_ads_report	level, start_date, end_date, account_id, limit	rows / actions / action_values / video	キャンペーン・広告セット・広告別に取得する

フィールド

ID	型	表示名	媒体側API名	説明
date_start	dimension	開始日	date_start	Meta広告インサイトの集計開始日です。
date_stop	dimension	終了日	date_stop	Meta広告インサイトの集計終了日です。
account_id	entity	広告アカウントID	account_id	広告アカウントを識別します。
account_name	entity	広告アカウント名	account_name	広告アカウントの表示名です。
campaign_id	dimension	キャンペーンID	campaign_id	キャンペーンを識別します。
campaign_name	dimension	キャンペーン	campaign_name	キャンペーン別の実績です。
adset_id	dimension	広告セットID	adset_id	広告セットを識別します。
adset_name	dimension	広告セット	adset_name	広告セット単位の配信実績です。
ad_id	dimension	広告ID	ad_id	広告を識別します。
ad_name	dimension	広告名	ad_name	広告単位の実績です。
objective	dimension	目的	objective	キャンペーン目的です。
optimization_goal	dimension	最適化目標	optimization_goal	広告セットの最適化目標です。
buying_type	dimension	購入タイプ	buying_type	オークションなどの購入タイプです。
spend	metric	広告費	spend	広告配信費用です。
impressions	metric	表示回数	impressions	広告表示回数です。
reach	metric	リーチ	reach	広告が到達した人数です。
frequency	metric	フリークエンシー	frequency	1人あたり平均表示回数です。
clicks	metric	クリック	clicks	Meta定義のクリック数です。
unique_clicks	metric	ユニーククリック	unique_clicks	クリックしたユニークユーザー数です。
cpc	metric	CPC	cpc	クリック単価です。
cpm	metric	CPM	cpm	1,000表示あたり費用です。
cpp	metric	CPP	cpp	1,000人リーチあたり費用です。
ctr	metric	CTR	ctr	クリック数を表示回数で割った率です。
unique_ctr	metric	ユニークCTR	unique_ctr	ユニーククリックベースのCTRです。
inline_link_clicks	metric	インラインリンククリック	inline_link_clicks	広告内リンクのクリック数です。
inline_link_click_ctr	metric	インラインリンクCTR	inline_link_click_ctr	リンククリックベースのCTRです。
unique_inline_link_clicks	metric	ユニークリンククリック	unique_inline_link_clicks	リンクをクリックしたユニークユーザー数です。
cost_per_inline_link_click	metric	リンククリック単価	cost_per_inline_link_click	インラインリンククリック1件あたり費用です。
cost_per_unique_inline_link_click	metric	ユニークリンククリック単価	cost_per_unique_inline_link_click	ユニークリンククリック1件あたり費用です。
actions	metric_array	アクション	actions	購入、リード、カート追加、動画再生などのaction_type別件数です。
action_values	metric_array	アクション値	action_values	購入金額など、action_type別の価値です。
cost_per_action_type	metric_array	アクション単価	cost_per_action_type	action_type別の1件あたり費用です。
conversions	derived_metric	購入CV	actions[purchase]	actions内のpurchase系action_typeを合算し、MCP標準ツールで返す派生値です。
conversion_value	derived_metric	購入CV値	action_values[purchase]	action_values内のpurchase系action_typeを合算し、MCP標準ツールで返す派生値です。
website_ctr	metric_array	WebサイトCTR	website_ctr	Webサイト遷移に関するCTRです。
outbound_clicks	metric_array	外部リンククリック	outbound_clicks	外部サイトへのクリック数です。
outbound_clicks_ctr	metric_array	外部リンクCTR	outbound_clicks_ctr	外部クリックベースのCTRです。
video_play_actions	metric_array	動画再生	video_play_actions	動画再生アクション数です。
video_p25_watched_actions	metric_array	動画25%再生	video_p25_watched_actions	動画を25%まで視聴したアクション数です。
video_p50_watched_actions	metric_array	動画50%再生	video_p50_watched_actions	動画を50%まで視聴したアクション数です。
video_p75_watched_actions	metric_array	動画75%再生	video_p75_watched_actions	動画を75%まで視聴したアクション数です。
video_p95_watched_actions	metric_array	動画95%再生	video_p95_watched_actions	動画を95%まで視聴したアクション数です。
video_p100_watched_actions	metric_array	動画100%再生	video_p100_watched_actions	動画を100%まで視聴したアクション数です。
video_avg_time_watched_actions	metric_array	平均動画視聴時間	video_avg_time_watched_actions	動画の平均視聴時間に関する指標です。
breakdown_age	breakdown	年齢	age	追加分解軸として年齢別に集計できます。
breakdown_gender	breakdown	性別	gender	追加分解軸として性別に集計できます。
breakdown_country	breakdown	国	country	追加分解軸として国別に集計できます。
breakdown_region	breakdown	地域	region	追加分解軸として地域別に集計できます。
breakdown_impression_device	breakdown	表示デバイス	impression_device	追加分解軸として表示デバイス別に集計できます。
breakdown_publisher_platform	breakdown	配信面	publisher_platform	Facebook、Instagramなどの配信面別に集計できます。
breakdown_platform_position	breakdown	配信位置	platform_position	フィード、ストーリーズなどの配信位置別に集計できます。
breakdown_device_platform	breakdown	デバイス種別	device_platform	モバイル、デスクトップなどの種別で分解できます。
action_breakdown_type	action_breakdown	アクション種別	action_type	actionsやaction_valuesをCV種別ごとに分解する軸です。
action_breakdown_destination	action_breakdown	アクション先	action_destination	アクションの到達先別に分解する軸です。
action_breakdown_device	action_breakdown	アクション端末	action_device	アクションが発生した端末別に分解する軸です。
account_balance	numeric	Account Balance	AdAccount.balance	Meta広告アカウント情報から取得するフィールドです。
account_currency	text	Account Currency	AdAccount.currency	Meta広告アカウント情報から取得するフィールドです。
account_status	text	Account Status	AdAccount.status	Meta広告アカウント情報から取得するフィールドです。
account_timezone	text	Account Timezone	AdAccount.timezone_name	Meta広告アカウント情報から取得するフィールドです。
account_timezone_offset_hours_utc	numeric	Account Timezone Offset Hours Utc	AdAccount.timezone_offset_hours_utc	Meta広告アカウント情報から取得するフィールドです。
accountid	text	Accountid	AdAccount.account_id	Meta広告アカウント情報から取得するフィールドです。
action_values_add_payment_info	expanded_value	Action Values Add Payment Info	action_values[action_type=add_payment_info]	Meta Insightsのaction_values配列を action_type=add_payment_info で展開した値です。
action_values_add_to_cart	expanded_value	Action Values Add To Cart	action_values[action_type=add_to_cart]	Meta Insightsのaction_values配列を action_type=add_to_cart で展開した値です。
action_values_add_to_wishlist	expanded_value	Action Values Add To Wishlist	action_values[action_type=add_to_wishlist]	Meta Insightsのaction_values配列を action_type=add_to_wishlist で展開した値です。
action_values_app_custom_event_fb_mobile_add_to_cart	expanded_value	Action Values App Custom Event Fb Mobile Add To Cart	action_values[action_type=app_custom_event_fb_mobile_add_to_cart]	Meta Insightsのaction_values配列を action_type=app_custom_event_fb_mobile_add_to_cart で展開した値です。
action_values_app_custom_event_fb_mobile_add_to_wishlist	expanded_value	Action Values App Custom Event Fb Mobile Add To Wishlist	action_values[action_type=app_custom_event_fb_mobile_add_to_wishlist]	Meta Insightsのaction_values配列を action_type=app_custom_event_fb_mobile_add_to_wishlist で展開した値です。
action_values_app_custom_event_fb_mobile_content_view	expanded_value	Action Values App Custom Event Fb Mobile Content View	action_values[action_type=app_custom_event_fb_mobile_content_view]	Meta Insightsのaction_values配列を action_type=app_custom_event_fb_mobile_content_view で展開した値です。
action_values_app_custom_event_fb_mobile_initiated_checkout	expanded_value	Action Values App Custom Event Fb Mobile Initiated Checkout	action_values[action_type=app_custom_event_fb_mobile_initiated_checkout]	Meta Insightsのaction_values配列を action_type=app_custom_event_fb_mobile_initiated_checkout で展開した値です。
action_values_app_custom_event_fb_mobile_purchase	expanded_value	Action Values App Custom Event Fb Mobile Purchase	action_values[action_type=app_custom_event_fb_mobile_purchase]	Meta Insightsのaction_values配列を action_type=app_custom_event_fb_mobile_purchase で展開した値です。
action_values_app_custom_event_other	expanded_value	Action Values App Custom Event Other	action_values[action_type=app_custom_event_other]	Meta Insightsのaction_values配列を action_type=app_custom_event_other で展開した値です。
action_values_click_to_call_call_confirm	expanded_value	Action Values Click To Call Call Confirm	action_values[action_type=click_to_call_call_confirm]	Meta Insightsのaction_values配列を action_type=click_to_call_call_confirm で展開した値です。
action_values_complete_registration	expanded_value	Action Values Complete Registration	action_values[action_type=complete_registration]	Meta Insightsのaction_values配列を action_type=complete_registration で展開した値です。
action_values_initiate_checkout	expanded_value	Action Values Initiate Checkout	action_values[action_type=initiate_checkout]	Meta Insightsのaction_values配列を action_type=initiate_checkout で展開した値です。
action_values_lead	expanded_value	Action Values Lead	action_values[action_type=lead]	Meta Insightsのaction_values配列を action_type=lead で展開した値です。
action_values_leadgen_grouped	expanded_value	Action Values Leadgen Grouped	action_values[action_type=leadgen_grouped]	Meta Insightsのaction_values配列を action_type=leadgen_grouped で展開した値です。
action_values_offsite_conversion_fb_pixel_add_payment_info	expanded_value	Action Values Offsite Conversion Fb Pixel Add Payment Info	action_values[action_type=offsite_conversion_fb_pixel_add_payment_info]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_add_payment_info で展開した値です。
action_values_offsite_conversion_fb_pixel_add_to_cart	expanded_value	Action Values Offsite Conversion Fb Pixel Add To Cart	action_values[action_type=offsite_conversion_fb_pixel_add_to_cart]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_add_to_cart で展開した値です。
action_values_offsite_conversion_fb_pixel_add_to_wishlist	expanded_value	Action Values Offsite Conversion Fb Pixel Add To Wishlist	action_values[action_type=offsite_conversion_fb_pixel_add_to_wishlist]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_add_to_wishlist で展開した値です。
action_values_offsite_conversion_fb_pixel_complete_registration	expanded_value	Action Values Offsite Conversion Fb Pixel Complete Registration	action_values[action_type=offsite_conversion_fb_pixel_complete_registration]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_complete_registration で展開した値です。
action_values_offsite_conversion_fb_pixel_custom	expanded_value	Action Values Offsite Conversion Fb Pixel Custom	action_values[action_type=offsite_conversion_fb_pixel_custom]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_custom で展開した値です。
action_values_offsite_conversion_fb_pixel_initiate_checkout	expanded_value	Action Values Offsite Conversion Fb Pixel Initiate Checkout	action_values[action_type=offsite_conversion_fb_pixel_initiate_checkout]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_initiate_checkout で展開した値です。
action_values_offsite_conversion_fb_pixel_lead	expanded_value	Action Values Offsite Conversion Fb Pixel Lead	action_values[action_type=offsite_conversion_fb_pixel_lead]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_lead で展開した値です。
action_values_offsite_conversion_fb_pixel_purchase	expanded_value	Action Values Offsite Conversion Fb Pixel Purchase	action_values[action_type=offsite_conversion_fb_pixel_purchase]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_purchase で展開した値です。
action_values_offsite_conversion_fb_pixel_search	expanded_value	Action Values Offsite Conversion Fb Pixel Search	action_values[action_type=offsite_conversion_fb_pixel_search]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_search で展開した値です。
action_values_offsite_conversion_fb_pixel_view_content	expanded_value	Action Values Offsite Conversion Fb Pixel View Content	action_values[action_type=offsite_conversion_fb_pixel_view_content]	Meta Insightsのaction_values配列を action_type=offsite_conversion_fb_pixel_view_content で展開した値です。
action_values_omni_add_to_cart	expanded_value	Action Values Omni Add To Cart	action_values[action_type=omni_add_to_cart]	Meta Insightsのaction_values配列を action_type=omni_add_to_cart で展開した値です。
action_values_omni_complete_registration	expanded_value	Action Values Omni Complete Registration	action_values[action_type=omni_complete_registration]	Meta Insightsのaction_values配列を action_type=omni_complete_registration で展開した値です。
action_values_omni_custom	expanded_value	Action Values Omni Custom	action_values[action_type=omni_custom]	Meta Insightsのaction_values配列を action_type=omni_custom で展開した値です。
action_values_omni_initiated_checkout	expanded_value	Action Values Omni Initiated Checkout	action_values[action_type=omni_initiated_checkout]	Meta Insightsのaction_values配列を action_type=omni_initiated_checkout で展開した値です。
action_values_omni_purchase	expanded_value	Action Values Omni Purchase	action_values[action_type=omni_purchase]	Meta Insightsのaction_values配列を action_type=omni_purchase で展開した値です。
action_values_omni_search	expanded_value	Action Values Omni Search	action_values[action_type=omni_search]	Meta Insightsのaction_values配列を action_type=omni_search で展開した値です。
action_values_omni_spend_credits	expanded_value	Action Values Omni Spend Credits	action_values[action_type=omni_spend_credits]	Meta Insightsのaction_values配列を action_type=omni_spend_credits で展開した値です。
action_values_omni_view_content	expanded_value	Action Values Omni View Content	action_values[action_type=omni_view_content]	Meta Insightsのaction_values配列を action_type=omni_view_content で展開した値です。
action_values_onsite_conversion_lead_grouped	expanded_value	Action Values Onsite Conversion Lead Grouped	action_values[action_type=onsite_conversion_lead_grouped]	Meta Insightsのaction_values配列を action_type=onsite_conversion_lead_grouped で展開した値です。
action_values_onsite_conversion_purchase	expanded_value	Action Values Onsite Conversion Purchase	action_values[action_type=onsite_conversion_purchase]	Meta Insightsのaction_values配列を action_type=onsite_conversion_purchase で展開した値です。
action_values_onsite_web_add_to_cart	expanded_value	Action Values Onsite Web Add To Cart	action_values[action_type=onsite_web_add_to_cart]	Meta Insightsのaction_values配列を action_type=onsite_web_add_to_cart で展開した値です。
action_values_onsite_web_app_add_to_cart	expanded_value	Action Values Onsite Web App Add To Cart	action_values[action_type=onsite_web_app_add_to_cart]	Meta Insightsのaction_values配列を action_type=onsite_web_app_add_to_cart で展開した値です。
action_values_onsite_web_app_purchase	expanded_value	Action Values Onsite Web App Purchase	action_values[action_type=onsite_web_app_purchase]	Meta Insightsのaction_values配列を action_type=onsite_web_app_purchase で展開した値です。
action_values_onsite_web_purchase	expanded_value	Action Values Onsite Web Purchase	action_values[action_type=onsite_web_purchase]	Meta Insightsのaction_values配列を action_type=onsite_web_purchase で展開した値です。
action_values_purchase	expanded_value	Action Values Purchase	action_values[action_type=purchase]	Meta Insightsのaction_values配列を action_type=purchase で展開した値です。
action_values_search	expanded_value	Action Values Search	action_values[action_type=search]	Meta Insightsのaction_values配列を action_type=search で展開した値です。
action_values_signup_event	expanded_value	Action Values Signup Event	action_values[action_type=signup_event]	Meta Insightsのaction_values配列を action_type=signup_event で展開した値です。
action_values_subscription_event	expanded_value	Action Values Subscription Event	action_values[action_type=subscription_event]	Meta Insightsのaction_values配列を action_type=subscription_event で展開した値です。
action_values_total	expanded_value	Action Values Total	action_values[action_type=total]	Meta Insightsのaction_values配列を action_type=total で展開した値です。
actions_add_payment_info	expanded_metric	Actions Add Payment Info	actions[action_type=add_payment_info]	Meta Insightsのactions配列を action_type=add_payment_info で展開した件数です。
actions_add_to_cart	expanded_metric	Actions Add To Cart	actions[action_type=add_to_cart]	Meta Insightsのactions配列を action_type=add_to_cart で展開した件数です。
actions_add_to_wishlist	expanded_metric	Actions Add To Wishlist	actions[action_type=add_to_wishlist]	Meta Insightsのactions配列を action_type=add_to_wishlist で展開した件数です。
actions_app_custom_event_fb_mobile_activate_app	expanded_metric	Actions App Custom Event Fb Mobile Activate App	actions[action_type=app_custom_event_fb_mobile_activate_app]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_activate_app で展開した件数です。
actions_app_custom_event_fb_mobile_add_payment_info	expanded_metric	Actions App Custom Event Fb Mobile Add Payment Info	actions[action_type=app_custom_event_fb_mobile_add_payment_info]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_add_payment_info で展開した件数です。
actions_app_custom_event_fb_mobile_add_to_cart	expanded_metric	Actions App Custom Event Fb Mobile Add To Cart	actions[action_type=app_custom_event_fb_mobile_add_to_cart]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_add_to_cart で展開した件数です。
actions_app_custom_event_fb_mobile_add_to_wishlist	expanded_metric	Actions App Custom Event Fb Mobile Add To Wishlist	actions[action_type=app_custom_event_fb_mobile_add_to_wishlist]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_add_to_wishlist で展開した件数です。
actions_app_custom_event_fb_mobile_complete_registration	expanded_metric	Actions App Custom Event Fb Mobile Complete Registration	actions[action_type=app_custom_event_fb_mobile_complete_registration]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_complete_registration で展開した件数です。
actions_app_custom_event_fb_mobile_content_view	expanded_metric	Actions App Custom Event Fb Mobile Content View	actions[action_type=app_custom_event_fb_mobile_content_view]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_content_view で展開した件数です。
actions_app_custom_event_fb_mobile_initiated_checkout	expanded_metric	Actions App Custom Event Fb Mobile Initiated Checkout	actions[action_type=app_custom_event_fb_mobile_initiated_checkout]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_initiated_checkout で展開した件数です。
actions_app_custom_event_fb_mobile_level_achieved	expanded_metric	Actions App Custom Event Fb Mobile Level Achieved	actions[action_type=app_custom_event_fb_mobile_level_achieved]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_level_achieved で展開した件数です。
actions_app_custom_event_fb_mobile_purchase	expanded_metric	Actions App Custom Event Fb Mobile Purchase	actions[action_type=app_custom_event_fb_mobile_purchase]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_purchase で展開した件数です。
actions_app_custom_event_fb_mobile_search	expanded_metric	Actions App Custom Event Fb Mobile Search	actions[action_type=app_custom_event_fb_mobile_search]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_search で展開した件数です。
actions_app_custom_event_fb_mobile_tutorial_completion	expanded_metric	Actions App Custom Event Fb Mobile Tutorial Completion	actions[action_type=app_custom_event_fb_mobile_tutorial_completion]	Meta Insightsのactions配列を action_type=app_custom_event_fb_mobile_tutorial_completion で展開した件数です。
actions_app_custom_event_other	expanded_metric	Actions App Custom Event Other	actions[action_type=app_custom_event_other]	Meta Insightsのactions配列を action_type=app_custom_event_other で展開した件数です。
actions_app_install	expanded_metric	Actions App Install	actions[action_type=app_install]	Meta Insightsのactions配列を action_type=app_install で展開した件数です。
actions_checkin	expanded_metric	Actions Checkin	actions[action_type=checkin]	Meta Insightsのactions配列を action_type=checkin で展開した件数です。
actions_click_to_call_call_confirm	expanded_metric	Actions Click To Call Call Confirm	actions[action_type=click_to_call_call_confirm]	Meta Insightsのactions配列を action_type=click_to_call_call_confirm で展開した件数です。
actions_click_to_call_native_20s_call_connect	expanded_metric	Actions Click To Call Native 20S Call Connect	actions[action_type=click_to_call_native_20s_call_connect]	Meta Insightsのactions配列を action_type=click_to_call_native_20s_call_connect で展開した件数です。
actions_click_to_call_native_60s_call_connect	expanded_metric	Actions Click To Call Native 60S Call Connect	actions[action_type=click_to_call_native_60s_call_connect]	Meta Insightsのactions配列を action_type=click_to_call_native_60s_call_connect で展開した件数です。
actions_click_to_call_native_call_placed	expanded_metric	Actions Click To Call Native Call Placed	actions[action_type=click_to_call_native_call_placed]	Meta Insightsのactions配列を action_type=click_to_call_native_call_placed で展開した件数です。
actions_comment	expanded_metric	Actions Comment	actions[action_type=comment]	Meta Insightsのactions配列を action_type=comment で展開した件数です。
actions_complete_registration	expanded_metric	Actions Complete Registration	actions[action_type=complete_registration]	Meta Insightsのactions配列を action_type=complete_registration で展開した件数です。
actions_initiate_checkout	expanded_metric	Actions Initiate Checkout	actions[action_type=initiate_checkout]	Meta Insightsのactions配列を action_type=initiate_checkout で展開した件数です。
actions_landing_page_view	expanded_metric	Actions Landing Page View	actions[action_type=landing_page_view]	Meta Insightsのactions配列を action_type=landing_page_view で展開した件数です。
actions_lead	expanded_metric	Actions Lead	actions[action_type=lead]	Meta Insightsのactions配列を action_type=lead で展開した件数です。
actions_leadgen_grouped	expanded_metric	Actions Leadgen Grouped	actions[action_type=leadgen_grouped]	Meta Insightsのactions配列を action_type=leadgen_grouped で展開した件数です。
actions_like	expanded_metric	Actions Like	actions[action_type=like]	Meta Insightsのactions配列を action_type=like で展開した件数です。
actions_link_click	expanded_metric	Actions Link Click	actions[action_type=link_click]	Meta Insightsのactions配列を action_type=link_click で展開した件数です。
actions_mobile_app_install	expanded_metric	Actions Mobile App Install	actions[action_type=mobile_app_install]	Meta Insightsのactions配列を action_type=mobile_app_install で展開した件数です。
actions_offsite_conversion_fb_pixel_add_payment_info	expanded_metric	Actions Offsite Conversion Fb Pixel Add Payment Info	actions[action_type=offsite_conversion_fb_pixel_add_payment_info]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_add_payment_info で展開した件数です。
actions_offsite_conversion_fb_pixel_add_to_cart	expanded_metric	Actions Offsite Conversion Fb Pixel Add To Cart	actions[action_type=offsite_conversion_fb_pixel_add_to_cart]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_add_to_cart で展開した件数です。
actions_offsite_conversion_fb_pixel_add_to_wishlist	expanded_metric	Actions Offsite Conversion Fb Pixel Add To Wishlist	actions[action_type=offsite_conversion_fb_pixel_add_to_wishlist]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_add_to_wishlist で展開した件数です。
actions_offsite_conversion_fb_pixel_complete_registration	expanded_metric	Actions Offsite Conversion Fb Pixel Complete Registration	actions[action_type=offsite_conversion_fb_pixel_complete_registration]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_complete_registration で展開した件数です。
actions_offsite_conversion_fb_pixel_custom	expanded_metric	Actions Offsite Conversion Fb Pixel Custom	actions[action_type=offsite_conversion_fb_pixel_custom]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_custom で展開した件数です。
actions_offsite_conversion_fb_pixel_initiate_checkout	expanded_metric	Actions Offsite Conversion Fb Pixel Initiate Checkout	actions[action_type=offsite_conversion_fb_pixel_initiate_checkout]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_initiate_checkout で展開した件数です。
actions_offsite_conversion_fb_pixel_lead	expanded_metric	Actions Offsite Conversion Fb Pixel Lead	actions[action_type=offsite_conversion_fb_pixel_lead]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_lead で展開した件数です。
actions_offsite_conversion_fb_pixel_purchase	expanded_metric	Actions Offsite Conversion Fb Pixel Purchase	actions[action_type=offsite_conversion_fb_pixel_purchase]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_purchase で展開した件数です。
actions_offsite_conversion_fb_pixel_search	expanded_metric	Actions Offsite Conversion Fb Pixel Search	actions[action_type=offsite_conversion_fb_pixel_search]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_search で展開した件数です。
actions_offsite_conversion_fb_pixel_view_content	expanded_metric	Actions Offsite Conversion Fb Pixel View Content	actions[action_type=offsite_conversion_fb_pixel_view_content]	Meta Insightsのactions配列を action_type=offsite_conversion_fb_pixel_view_content で展開した件数です。
actions_omni_achievement_unlocked	expanded_metric	Actions Omni Achievement Unlocked	actions[action_type=omni_achievement_unlocked]	Meta Insightsのactions配列を action_type=omni_achievement_unlocked で展開した件数です。
actions_omni_activate_app	expanded_metric	Actions Omni Activate App	actions[action_type=omni_activate_app]	Meta Insightsのactions配列を action_type=omni_activate_app で展開した件数です。
actions_omni_add_to_cart	expanded_metric	Actions Omni Add To Cart	actions[action_type=omni_add_to_cart]	Meta Insightsのactions配列を action_type=omni_add_to_cart で展開した件数です。
actions_omni_app_install	expanded_metric	Actions Omni App Install	actions[action_type=omni_app_install]	Meta Insightsのactions配列を action_type=omni_app_install で展開した件数です。
actions_omni_complete_registration	expanded_metric	Actions Omni Complete Registration	actions[action_type=omni_complete_registration]	Meta Insightsのactions配列を action_type=omni_complete_registration で展開した件数です。
actions_omni_custom	expanded_metric	Actions Omni Custom	actions[action_type=omni_custom]	Meta Insightsのactions配列を action_type=omni_custom で展開した件数です。
actions_omni_initiated_checkout	expanded_metric	Actions Omni Initiated Checkout	actions[action_type=omni_initiated_checkout]	Meta Insightsのactions配列を action_type=omni_initiated_checkout で展開した件数です。
actions_omni_level_achieved	expanded_metric	Actions Omni Level Achieved	actions[action_type=omni_level_achieved]	Meta Insightsのactions配列を action_type=omni_level_achieved で展開した件数です。
actions_omni_purchase	expanded_metric	Actions Omni Purchase	actions[action_type=omni_purchase]	Meta Insightsのactions配列を action_type=omni_purchase で展開した件数です。
actions_omni_rate	expanded_metric	Actions Omni Rate	actions[action_type=omni_rate]	Meta Insightsのactions配列を action_type=omni_rate で展開した件数です。
actions_omni_search	expanded_metric	Actions Omni Search	actions[action_type=omni_search]	Meta Insightsのactions配列を action_type=omni_search で展開した件数です。
actions_omni_spend_credits	expanded_metric	Actions Omni Spend Credits	actions[action_type=omni_spend_credits]	Meta Insightsのactions配列を action_type=omni_spend_credits で展開した件数です。
actions_omni_tutorial_completion	expanded_metric	Actions Omni Tutorial Completion	actions[action_type=omni_tutorial_completion]	Meta Insightsのactions配列を action_type=omni_tutorial_completion で展開した件数です。
actions_omni_view_content	expanded_metric	Actions Omni View Content	actions[action_type=omni_view_content]	Meta Insightsのactions配列を action_type=omni_view_content で展開した件数です。
actions_onsite_conversion_flow_complete	expanded_metric	Actions Onsite Conversion Flow Complete	actions[action_type=onsite_conversion_flow_complete]	Meta Insightsのactions配列を action_type=onsite_conversion_flow_complete で展開した件数です。
actions_onsite_conversion_lead_grouped	expanded_metric	Actions Onsite Conversion Lead Grouped	actions[action_type=onsite_conversion_lead_grouped]	Meta Insightsのactions配列を action_type=onsite_conversion_lead_grouped で展開した件数です。
actions_onsite_conversion_messaging_block	expanded_metric	Actions Onsite Conversion Messaging Block	actions[action_type=onsite_conversion_messaging_block]	Meta Insightsのactions配列を action_type=onsite_conversion_messaging_block で展開した件数です。
actions_onsite_conversion_messaging_conversation_started_7d	expanded_metric	Actions Onsite Conversion Messaging Conversation Started 7D	actions[action_type=onsite_conversion_messaging_conversation_started_7d]	Meta Insightsのactions配列を action_type=onsite_conversion_messaging_conversation_started_7d で展開した件数です。
actions_onsite_conversion_messaging_first_reply	expanded_metric	Actions Onsite Conversion Messaging First Reply	actions[action_type=onsite_conversion_messaging_first_reply]	Meta Insightsのactions配列を action_type=onsite_conversion_messaging_first_reply で展開した件数です。

Amazon広告

広告 / LWA OAuth

準備中

Amazon Adsのプロフィール別広告実績を読み取ります。

MCPツール

ツール	引数	戻り値	説明
amazon_ads_performance_summary	start_date, end_date	cost / clicks / impressions / sales	Amazon広告の実績を取得する

フィールド

ID	型	表示名	媒体側API名	説明
date	official_attribute	Date	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
portfolioId	official_attribute	Portfolio Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignId	official_attribute	Campaign Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignName	official_attribute	Campaign Name	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignStatus	official_attribute	Campaign Status	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignBudgetType	official_attribute	Campaign Budget Type	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignBudgetAmount	official_attribute	Campaign Budget Amount	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
campaignBudgetCurrencyCode	official_attribute	Campaign Budget Currency Code	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
adGroupId	official_attribute	Ad Group Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
adGroupName	official_attribute	Ad Group Name	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
adId	official_attribute	Ad Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
keywordId	official_attribute	Keyword Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
keyword	official_attribute	Keyword	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
keywordType	official_attribute	Keyword Type	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
matchType	official_attribute	Match Type	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
targeting	official_attribute	Targeting	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
targetingId	official_attribute	Targeting Id	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
targetingExpression	official_attribute	Targeting Expression	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
targetingText	official_attribute	Targeting Text	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
resolvedExpression	official_attribute	Resolved Expression	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
placementClassification	official_attribute	Placement Classification	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
creativeAsin	official_attribute	Creative Asin	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
creativeSku	official_attribute	Creative Sku	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
advertisedAsin	official_attribute	Advertised Asin	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
advertisedSku	official_attribute	Advertised Sku	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasedAsin	official_metric	Purchased Asin	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasedSku	official_metric	Purchased Sku	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
asin	official_attribute	Asin	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
sku	official_attribute	Sku	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
impressions	official_metric	Impressions	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
clicks	official_metric	Clicks	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
cost	official_metric	Cost	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
spend	official_metric	Spend	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
clickThroughRate	official_metric	Click Through Rate	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
costPerClick	official_metric	Cost Per Click	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
topOfSearchImpressionShare	official_metric	Top Of Search Impression Share	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchases1d	official_metric	Purchases1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchases7d	official_metric	Purchases7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchases14d	official_metric	Purchases14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchases30d	official_metric	Purchases30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasesSameSku1d	official_metric	Purchases Same Sku1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasesSameSku7d	official_metric	Purchases Same Sku7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasesSameSku14d	official_metric	Purchases Same Sku14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
purchasesSameSku30d	official_metric	Purchases Same Sku30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldClicks1d	official_metric	Units Sold Clicks1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldClicks7d	official_metric	Units Sold Clicks7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldClicks14d	official_metric	Units Sold Clicks14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldClicks30d	official_metric	Units Sold Clicks30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldSameSku1d	official_metric	Units Sold Same Sku1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldSameSku7d	official_metric	Units Sold Same Sku7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldSameSku14d	official_metric	Units Sold Same Sku14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
unitsSoldSameSku30d	official_metric	Units Sold Same Sku30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
sales1d	official_metric	Sales1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
sales7d	official_metric	Sales7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
sales14d	official_metric	Sales14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
sales30d	official_metric	Sales30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
attributedSalesSameSku1d	official_metric	Attributed Sales Same Sku1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
attributedSalesSameSku7d	official_metric	Attributed Sales Same Sku7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
attributedSalesSameSku14d	official_metric	Attributed Sales Same Sku14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
attributedSalesSameSku30d	official_metric	Attributed Sales Same Sku30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
salesOtherSku7d	official_metric	Sales Other Sku7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
salesOtherSku14d	official_metric	Sales Other Sku14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
addToCart	official_metric	Add To Cart	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
addToCartClicks	official_metric	Add To Cart Clicks	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
addToCartRate	official_metric	Add To Cart Rate	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
brandedSearches	official_metric	Branded Searches	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
brandedSearchesClicks	official_metric	Branded Searches Clicks	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandPurchases1d	official_metric	New To Brand Purchases1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandPurchases7d	official_metric	New To Brand Purchases7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandPurchases14d	official_metric	New To Brand Purchases14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandPurchases30d	official_metric	New To Brand Purchases30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandPurchasesPercentage14d	official_metric	New To Brand Purchases Percentage14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandSales1d	official_metric	New To Brand Sales1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandSales7d	official_metric	New To Brand Sales7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandSales14d	official_metric	New To Brand Sales14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandSales30d	official_metric	New To Brand Sales30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandSalesPercentage14d	official_metric	New To Brand Sales Percentage14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandUnitsSold1d	official_metric	New To Brand Units Sold1d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandUnitsSold7d	official_metric	New To Brand Units Sold7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandUnitsSold14d	official_metric	New To Brand Units Sold14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandUnitsSold30d	official_metric	New To Brand Units Sold30d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
newToBrandUnitsSoldPercentage14d	official_metric	New To Brand Units Sold Percentage14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
roasClicks7d	official_metric	Roas Clicks7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
roasClicks14d	official_metric	Roas Clicks14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
acosClicks7d	official_metric	Acos Clicks7d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
acosClicks14d	official_metric	Acos Clicks14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
kindleEditionNormalizedPagesRead14d	official_metric	Kindle Edition Normalized Pages Read14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。
kindleEditionNormalizedPagesRoyalties14d	official_metric	Kindle Edition Normalized Pages Royalties14d	Amazon Ads Reporting v3 column	Amazon Ads Sponsored Ads v3レポートで利用される列名です。

Adjust

広告 / API token

提供中

Adjustのアプリ別インストール、クリック、表示回数、広告費、ネットワーク別実績を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_adjust_accounts	なし	account_id / account_name	接続済みAdjustアカウントを一覧化する
list_adjust_apps	account	app token / name	Adjustで参照できるアプリを一覧化する
adjust_performance_summary	start_date, end_date, app_tokens	installs / clicks / impressions / cost	アプリ別・日別実績を取得する
run_adjust_report	start_date, end_date, dimensions, metrics	rows / totals / warnings	Adjust Report Service APIの任意集計を取得する

フィールド

ID	型	表示名	媒体側API名	説明
day	dimension	日付	day	Adjustレポートの日次集計軸です。
week	dimension	週	week	週別の集計軸です。
month	dimension	月	month	月別の集計軸です。
app	dimension	アプリ	app	Adjustで管理しているアプリ名です。
app_token	dimension	App Token	app_token	Adjustのアプリ識別子です。
network	dimension	ネットワーク	network	流入元の広告ネットワークです。
campaign	dimension	キャンペーン	campaign	Adjustリンク階層のキャンペーンです。
campaign_network	dimension	媒体キャンペーン名	campaign_network	ネットワーク側のキャンペーン名です。
campaign_id_network	dimension	媒体キャンペーンID	campaign_id_network	ネットワーク側のキャンペーンIDです。
adgroup	dimension	広告グループ	adgroup	Adjustリンク階層の広告グループです。
creative	dimension	クリエイティブ	creative	Adjustリンク階層のクリエイティブです。
country	dimension	国	country	ユーザーの国です。
country_code	dimension	国コード	country_code	ISO 3166形式の国コードです。
os_name	dimension	OS	os_name	iOS、AndroidなどのOSです。
device_type	dimension	デバイス	device_type	phone、tabletなどの端末種別です。
installs	metric	インストール	installs	Adjustが計測したインストール数です。
clicks	metric	クリック	clicks	Adjustが計測したクリック数です。
impressions	metric	表示回数	impressions	Adjustが計測した表示回数です。
cost	metric	広告費	cost	Adjustレポート上の広告費です。
ecpi	metric	eCPI	ecpi	インストールあたり広告費です。
network_installs	metric	媒体インストール	network_installs	ネットワーク側計測のインストール数です。
network_cost	metric	媒体広告費	network_cost	ネットワーク側計測の広告費です。
network_ecpi	metric	媒体eCPI	network_ecpi	ネットワーク側計測のeCPIです。
revenue	metric	収益	revenue	Adjustで計測された収益です。

AppsFlyer

広告 / API V2 token

提供中

AppsFlyer Pull API aggregateから日別、媒体別、国別の集計レポートを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_appsflyer_accounts	なし	account_id / account_name / app_id	接続済みAppsFlyerアカウントを一覧化する
appsflyer_daily_report	start_date, end_date, account, media_source	rows / totals	AppsFlyerの日別集計を取得する
appsflyer_partners_report	start_date, end_date, by_date	rows / totals	AppsFlyerの媒体別集計を取得する
appsflyer_geo_report	start_date, end_date, by_date	rows / totals	AppsFlyerの国別集計を取得する
run_appsflyer_aggregate_report	report_type, start_date, end_date	rows / totals	AppsFlyer Pull API aggregateの任意集計を取得する

フィールド

ID	型	表示名	媒体側API名	説明
app_id	argument	App ID	app_id	AppsFlyerで管理するアプリ識別子です。
from	argument	開始日	from	LTV集計の開始日です。
to	argument	終了日	to	LTV集計の終了日です。
media_source_filter	argument	媒体絞り込み	media_source	特定の媒体だけを取得するための絞り込みです。
timezone	argument	タイムゾーン	timezone	AppsFlyerアプリ設定に合わせたJoda-Time形式のタイムゾーンです。
reattr	argument	リターゲティング	reattr	trueの場合はリターゲティング集計を取得します。
attribution_touch_type	argument	タッチ種別	attribution_touch_type	impressionなどのアトリビューションタッチ種別です。
date	dimension	日付	Date	Dailyまたはby date系レポートの日付です。
media_source	dimension	媒体	Media Source	流入元の広告媒体またはパートナーです。
campaign	dimension	キャンペーン	Campaign	AppsFlyerレポート上のキャンペーンです。
campaign_id	dimension	キャンペーンID	Campaign ID	媒体側またはAppsFlyer側のキャンペーン識別子です。
country	dimension	国	Country	Geo系レポートで使う国名または国コードです。
platform	dimension	プラットフォーム	Platform	iOS、Androidなどのアプリ種別です。
agency	dimension	代理店	Agency	AppsFlyerで代理店透明性が有効な場合に返る代理店軸です。
installs	metric	インストール	Installs	AppsFlyerが計測したインストール数です。
clicks	metric	クリック	Clicks	AppsFlyerが計測したクリック数です。
impressions	metric	表示回数	Impressions	AppsFlyerが計測した広告表示回数です。
conversion_rate	metric	CVR	Conversion Rate	クリックまたは表示に対するインストール率です。
sessions	metric	セッション	Sessions	アプリ起動やセッション数です。
loyal_users	metric	ロイヤルユーザー	Loyal Users	AppsFlyerで定義されたロイヤルユーザー数です。
cost	metric	広告費	Cost / Total Cost	AppsFlyerレポート上の広告費です。
revenue	metric	収益	Revenue / Total Revenue	AppsFlyerで計測された収益です。
roi	metric	ROI	ROI	費用に対する収益指標です。
arpu	metric	ARPU	ARPU	ユーザーあたり平均収益です。
ecpi	metric	eCPI	Average eCPI	インストールあたり平均広告費です。

LINE広告

広告 / アクセスキー + シークレットキー

準備中

LINE広告のAds Management APIからキャンペーン、広告グループ、広告別の実績レポートを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_line_ads_accounts	なし	account_id / account_name / adaccount_id	接続済みLINE広告アカウントを一覧化する
line_ads_performance_summary	start_date, end_date, account	impressions / clicks / cost / CV	キャンペーン別実績を取得する
run_line_ads_report	start_date, end_date, level	rows / totals	オンラインレポートを任意の粒度で取得する

フィールド

ID	型	表示名	媒体側API名	説明
adaccount_id	argument	広告アカウントID	adaccountId	LINE広告の広告アカウント識別子です。
since	argument	開始日	since	レポート集計の開始日です。
until	argument	終了日	until	レポート集計の終了日です。
level	argument	粒度	reportLevel	campaign / adgroup / ad のレポート粒度です。
campaign	dimension	キャンペーン	campaign	キャンペーン別の実績です。
adgroup	dimension	広告グループ	adgroup	広告グループ別の実績です。
ad	dimension	広告	ad	広告（クリエイティブ）別の実績です。
imp	metric	表示回数	imp	LINE広告の表示回数です。
click	metric	クリック	click	LINE広告のクリック数です。
cost	metric	費用	cost	LINE広告の消化金額です。
cv	metric	CV	cv	LINE広告で計測されたコンバージョン数です。
ctr	metric	CTR	ctr	表示回数に対するクリック率です。
cpc	metric	CPC	cpc	クリック単価です。
cpm	metric	CPM	cpm	1,000回表示あたりの費用です。

Criteo

広告 / client ID + client secret

準備中

Criteoのstatistics/reportからキャンペーン別、日別の表示回数、クリック、費用を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_criteo_advertisers	account	advertiser_id / name	参照できる広告主を一覧化する
criteo_performance_summary	start_date, end_date, advertiser_ids	impressions / clicks / cost	日別実績を取得する
run_criteo_report	start_date, end_date, dimensions, metrics	rows / totals	statistics/reportの任意集計を取得する

フィールド

ID	型	表示名	媒体側API名	説明
advertiser_ids	argument	広告主ID	advertiserIds	対象広告主の数値IDです。カンマ区切りで複数指定できます。
start_date	argument	開始日	startDate	レポート集計の開始日です。
end_date	argument	終了日	endDate	レポート集計の終了日です。
currency	argument	通貨	currency	集計に使う通貨コードです（既定はJPY）。
day	dimension	日付	Day	日別の集計軸です。Hour / Week / Month / Yearも使えます。
campaign	dimension	キャンペーン	Campaign	キャンペーン別の実績です。
adset	dimension	広告セット	Adset	広告セット別の実績です。
ad	dimension	広告	Ad	広告別の実績です。
device	dimension	デバイス	Device	デバイス別の集計軸です。
os	dimension	OS	Os	OS別の集計軸です。
displays	metric	表示回数	Displays	Criteo広告の表示回数です。
clicks	metric	クリック	Clicks	Criteo広告のクリック数です。
advertiser_cost	metric	費用	AdvertiserCost	広告主に請求される費用です。
sales	metric	販売件数	SalesClientAttribution	アトリビューション設定に基づく販売件数です。
revenue	metric	売上	RevenueGeneratedClientAttribution	アトリビューション設定に基づく売上です。
visits	metric	訪問	Visits	広告経由の訪問数です。

Singular

広告 / APIキー

準備中

SingularのReporting APIからアプリ×媒体の広告費、インストールの集計レポートを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_singular_accounts	なし	account_id / account_name	接続済みSingularアカウントを一覧化する
run_singular_report	start_date, end_date, dimensions, metrics	rows / totals（生成中はreport_id）	アプリ×媒体の集計レポートを取得する
get_singular_report_result	report_id	rows / totals	生成中だったSingularレポートの結果を取得する

フィールド

ID	型	表示名	媒体側API名	説明
start_date	argument	開始日	start_date	レポート集計の開始日です。1回の取得は最大30日です。
end_date	argument	終了日	end_date	レポート集計の終了日です。
time_breakdown	argument	期間粒度	time_breakdown	all / day / week / month の期間粒度です。
app_filter	argument	アプリ絞り込み	filters	アプリ名で絞り込む場合に指定します。
source_filter	argument	媒体絞り込み	filters	媒体名で絞り込む場合に指定します。
app	dimension	アプリ	app	アプリ別の集計軸です。
source	dimension	媒体	source	広告媒体（アドネットワーク）別の集計軸です。
os	dimension	OS	os	OS別の集計軸です。
platform	dimension	プラットフォーム	platform	iOS / Androidなどのプラットフォーム軸です。
country_field	dimension	国	country_field	国別の集計軸です。
adn_campaign_name	dimension	キャンペーン	adn_campaign_name	媒体側キャンペーン名の集計軸です。
adn_cost	metric	広告費	adn_cost	媒体側で計測された広告費です。
adn_impressions	metric	表示回数	adn_impressions	媒体側で計測された表示回数です。
custom_clicks	metric	クリック	custom_clicks	Singularの推奨ロジックで統合されたクリック数です。
custom_installs	metric	インストール	custom_installs	Singularの推奨ロジックで統合されたインストール数です。
revenue	metric	収益	revenue	コホート設定に基づく収益です。
ctr	metric	CTR	ctr	表示回数に対するクリック率です。
ecpi	metric	eCPI	ecpi	インストールあたり平均広告費です。

Apple Search Ads

広告 / API credentials

準備中

Apple Search Adsのアカウント、キャンペーン、広告実績を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_apple_search_ads_accounts	なし	org_id / name	Apple Search Adsの組織を一覧化する
list_apple_search_ads_campaigns	org_id	campaign_id / name / status	キャンペーン一覧を取得する
apple_search_ads_campaign_report	start_date, end_date, org_id	spend / taps / installs	キャンペーン別広告実績を取得する

フィールド

ID	型	表示名	媒体側API名	説明
average_cpa_tap_through	official_metric	Average CPA (Tap-Through)	Average CPA (Tap-Through)	Tap-through average cost-per-acquisition (CPA) is total campaign spend divided by the number of taps on your ad that led to installs within the reporting period.
average_cpa_total	official_metric	Average CPA (Total)	Average CPA (Total)	Total average tap-through cost-per-acquisition (CPA) is total campaign spend divided by total installs resulting from a view or a tap on your ad within the reporting period.
average_cpm	official_metric	Average CPM	Average CPM	Average cost-per-thousand-impressions (CPM) is the average amount you pay per one thousand ad impressions on the App Store.
average_cpt	official_metric	Average CPT	Average CPT	Average cost-per-tap (CPT) is the average amount you’ve paid for a tap on your ad.
average_daily_spend	official_metric	Average Daily Spend	Average Daily Spend	The average amount spent each day. This is calculated as spend divided by the number of days selected in the Campaigns dashboard date range, with campaign duration taken into account.
cr_tap_through	official_metric	CR (Tap-Through)	CR (Tap-Through)	Tap-through conversion rate (CR) is total installs resulting from taps on your ad divided by the total number of taps within the reporting period.
cr_total	official_metric	CR (Total)	CR (Total)	Total conversion rate (CR) is total installs resulting from a view or a tap on your ad divided by the total number of taps within the reporting period.
impression_share_all_ad_positions	official_metric	Impression Share (All Ad Positions)	Impression Share (All Ad Positions)	The number of times your ad was shown in any ad position for a specific search term, out of the total number of searches on that search term, in the same App Store countries and regions. Impression share is displayed as a percentage range, such as 0-10%, 11-2…
impression_share_first_ad_position	official_metric	Impression Share (First Ad Position)	Impression Share (First Ad Position)	The number of times your ad was shown in the first position for a specific search term, out of the total number of searches on that search term, in the same App Store countries and regions. Impression share is displayed as a percentage range, such as 0-10%, 1…
impressions	official_metric	Impressions	Impressions	The number of times your ad appeared on the App Store within the reporting time period.
installs_tap_through	official_metric	Installs (Tap-Through)	Installs (Tap-Through)	The total number of new downloads and redownloads from users who tapped on your ad within a 30-day window.
installs_total	official_metric	Installs (Total)	Installs (Total)	The total number of tap-through and view-through new downloads and redownloads from an ad within the reporting period.
installs_view_through	official_metric	Installs (View-Through)	Installs (View-Through)	The total number of new downloads and redownloads from users who viewed your ad but didn’t tap on it within a one-day window.
match_source	official_metric	Match Source	Match Source	This identifies whether your impression was the result of Search Match or a bidded keyword.
new_downloads_tap_through	official_metric	New Downloads (Tap-Through)	New Downloads (Tap-Through)	New downloads from users who tapped on your ad and have not previously downloaded your app. These are counted within a 30-day window.
new_downloads_total	official_metric	New Downloads (Total)	New Downloads (Total)	The total number of tap-through and view-through new downloads within the reporting period.
new_downloads_view_through	official_metric	New Downloads (View-Through)	New Downloads (View-Through)	New downloads from users who viewed your ad but didn’t tap on it, and have not previously downloaded your app. These are counted within a one-day window.
pre_orders_placed_tap_through	official_metric	Pre-orders Placed (Tap-Through)	Pre-orders Placed (Tap-Through)	The total number of pre-orders placed by users who tapped your ad. A pre-order placed (tap-through) is counted when a user has tapped your ad and authenticated with Face ID, Touch ID, or their passcode to allow the app to be downloaded on release day, within…
pre_orders_placed_total	official_metric	Pre-orders Placed (Total)	Pre-orders Placed (Total)	The total number of tap-through and view-through pre-orders placed resulting from an ad within the reporting period.
pre_orders_placed_view_through	official_metric	Pre-orders Placed (View-Through)	Pre-orders Placed (View-Through)	The total number of pre-orders placed from users who viewed your ad, but didn’t tap it. A pre-order placed (view-through) is counted within 24 hours of viewing your ad, and within 60 days of the app download. This does not account for any pre-orders canceled…
rank	official_metric	Rank	Rank	How your app ranks in terms of Impression Share (First Ad Position) or Impression Share (All Ad Positions) compared to other apps in the same countries and regions. Rank is displayed as numbers from 1 to 5 or >5, with 1 being the highest rank. This metric is…
redownloads_tap_through	official_metric	Redownloads (Tap-Through)	Redownloads (Tap-Through)	A redownload is when a user downloads your app, deletes it, then downloads it again on the same device or a different one following an ad tap. A tap-through redownload is counted when a user redownloads your app within 30 days of tapping on the ad.
redownloads_total	official_metric	Redownloads (Total)	Redownloads (Total)	The total number of tap-through and view-through redownloads within the reporting period.
redownloads_view_through	official_metric	Redownloads (View-Through)	Redownloads (View-Through)	A redownload is when a user downloads your app, deletes it, then downloads it again on the same device or a different one following an ad view. A view-through redownload is counted when a user redownloads your app without tapping on the ad within one day of t…
search_popularity	official_metric	Search Popularity	Search Popularity	The popularity of a keyword, based on App Store searches. Search popularity is displayed as numbers from 1 to 5, with 5 being the most popular.
search_term	official_metric	Search Term	Search Term	Search terms are the words and phrases that people have used to search for the particular type of app they’re looking for.
spend	official_metric	Spend	Spend	The sum of the cost of each customer tap on your ad over the period of time set for your reporting.
taps	official_metric	Taps	Taps	The number of times your ad was tapped by users within the reporting time period.
ttr	official_metric	TTR	TTR	The tap-through rate (TTR) is the number of times your ad was tapped by customers divided by the total impressions your ad received.
partners	official_metric	Partners	Partners	Find a partner to help you optimize performance.
certification	official_metric	Certification	Certification	Fast-track your skills with our curated Apple Ads course.
news_and_updates	official_metric	News and Updates	News and Updates	Read the latest about Apple Ads.
countries_and_regions	official_metric	Countries and Regions	Countries and Regions	See where ads on the App Store are available.
id	api_entity_field	キャンペーンID	Campaign.id	Campaign Management APIのキャンペーンIDです。
name	api_entity_field	キャンペーン名	Campaign.name	Campaign Management APIのキャンペーン名です。
adamId	api_entity_field	アプリID	Campaign.adamId	対象アプリのApple IDです。
status	api_entity_field	ステータス	Campaign.status	キャンペーン状態です。
servingStatus	api_entity_field	配信ステータス	Campaign.servingStatus	配信可否の状態です。
dailyBudgetAmount	api_entity_field	日予算	Campaign.dailyBudgetAmount	日予算金額です。
budgetAmount	api_entity_field	総予算	Campaign.budgetAmount	キャンペーン予算金額です。
countriesOrRegions	api_entity_field	国/地域	Campaign.countriesOrRegions	配信対象国または地域です。
localSpend	report_field	広告費	ReportingData.localSpend	レポートレスポンスの現地通貨広告費です。

Shopify

EC / Admin API token / OAuth

提供中

売上、注文、商品、バリアント、顧客集計、在庫、返品、マーケティングイベントを読み取ります。個人情報は標準サマリーでは返しません。

MCPツール

ツール	引数	戻り値	説明
shopify_sales_summary	start_date, end_date	sales / orders / daily	Shopify売上の日次サマリーを取得する
shopify_recent_orders	limit	orders	直近注文を取得する
shopify_products	limit, query	products	商品一覧を取得する
shopify_customers_summary	limit	customers / summary	顧客サマリーを取得する
shopify_inventory_summary	limit	inventory	在庫サマリーを取得する
shopify_marketing_events	limit	marketing_events	マーケティングイベントを取得する
shopify_returns_summary	limit	returns / return_line_items	返品サマリーを取得する

フィールド

ID	型	表示名	媒体側API名	説明
shop_name	returned_entity	ストア名	shop.name	shop.nameから取得する接続先ストア名です。
shop_currency	returned_dimension	ストア通貨	shop.currencyCode	shop.currencyCodeから取得するストア通貨です。
shop_domain	returned_dimension	管理ドメイン	shop.myshopifyDomain	shop.myshopifyDomainから取得するShopify管理ドメインです。
access_scopes	returned_dimension	接続scope	currentAppInstallation.accessScopes	currentAppInstallation.accessScopesから取得するOAuth scope一覧です。
order_number	returned_dimension	注文番号	Order.name	Order.nameから取得する注文番号です。
order_datetime	returned_dimension	注文作成日時	Order.createdAt	Order.createdAtから取得する注文作成日時です。
order_date	returned_dimension	注文日	Order.createdAt	Order.createdAtを日付単位に正規化した値です。
status	returned_dimension	決済ステータス	Order.displayFinancialStatus	Order.displayFinancialStatusから取得する決済ステータスです。
fulfillment	returned_dimension	配送ステータス	Order.displayFulfillmentStatus	Order.displayFulfillmentStatusから取得する配送・フルフィルメントステータスです。
is_cancelled	returned_dimension	キャンセル有無	Order.cancelledAt	Order.cancelledAtの有無から判定します。
total_price	returned_metric	注文金額	Order.currentTotalPriceSet.shopMoney.amount	Order.currentTotalPriceSet.shopMoney.amountから取得する注文金額です。
currency	returned_dimension	注文通貨	Order.currentTotalPriceSet.shopMoney.currencyCode	Order.currentTotalPriceSet.shopMoney.currencyCodeから取得する通貨です。
items	returned_entity	注文明細サマリー	Order.lineItems	lineItemsから商品名と数量をまとめて返します。
item_name	returned_dimension	注文明細商品名	LineItem.title	LineItem.titleから取得する商品名です。
item_units	returned_metric	注文明細数量	LineItem.quantity	LineItem.quantityから取得する数量です。
product_title	returned_dimension	商品名	Product.title	Product.titleから取得する商品名です。
product_handle	returned_dimension	商品ハンドル	Product.handle	Product.handleから取得するURLハンドルです。
product_status	returned_dimension	商品ステータス	Product.status	Product.statusから取得する公開ステータスです。
product_type	returned_dimension	商品タイプ	Product.productType	Product.productTypeから取得する商品タイプです。
vendor	returned_dimension	ベンダー	Product.vendor	Product.vendorから取得するベンダーです。
product_created_at	returned_dimension	商品作成日時	Product.createdAt	Product.createdAtから取得する商品作成日時です。
product_updated_at	returned_dimension	商品更新日時	Product.updatedAt	Product.updatedAtから取得する商品更新日時です。
variant_title	returned_dimension	バリアント名	ProductVariant.title	ProductVariant.titleから取得するバリアント名です。
variant_sku	returned_dimension	バリアントSKU	ProductVariant.sku	ProductVariant.skuから取得するSKUです。
variant_price	returned_metric	バリアント価格	ProductVariant.price	ProductVariant.priceから取得する販売価格です。
sampled_customers	returned_metric	サンプル顧客数	Customer aggregate	顧客サマリーで取得したサンプル顧客数です。
total_orders_in_sample	returned_metric	サンプル内注文数	Customer.numberOfOrders	Customer.numberOfOrdersをサンプル内で集計した値です。
repeat_customers_in_sample	returned_metric	サンプル内リピート顧客数	Customer.numberOfOrders	複数回注文した顧客数をサンプル内で集計します。
total_amount_spent_in_sample	returned_metric	サンプル内累計購入金額	Customer.amountSpent.amount	Customer.amountSpent.amountをサンプル内で集計した値です。
customer_currency	returned_dimension	顧客金額通貨	Customer.amountSpent.currencyCode	Customer.amountSpent.currencyCodeから取得する通貨です。
oldest_customer_created_at	returned_dimension	最古顧客作成日時	Customer.createdAt	サンプル内で最も古いCustomer.createdAtです。
newest_customer_created_at	returned_dimension	最新顧客作成日時	Customer.createdAt	サンプル内で最も新しいCustomer.createdAtです。
email_marketing_states	returned_dimension	メール同意状態	Customer.emailMarketingConsent.marketingState	Customer.emailMarketingConsent.marketingStateを集計します。
sms_marketing_states	returned_dimension	SMS同意状態	Customer.smsMarketingConsent.marketingState	Customer.smsMarketingConsent.marketingStateを集計します。
sampled_inventory_items	returned_metric	サンプル在庫アイテム数	InventoryItem aggregate	在庫サマリーで取得したInventoryItem数です。
tracked_items	returned_metric	在庫追跡商品数	InventoryItem.tracked	InventoryItem.trackedから在庫追跡対象数を集計します。
quantity_available	returned_metric	販売可能在庫	InventoryLevel.quantities[available]	InventoryLevel.quantities(name: available)を集計します。
quantity_committed	returned_metric	引当済み在庫	InventoryLevel.quantities[committed]	InventoryLevel.quantities(name: committed)を集計します。
quantity_on_hand	returned_metric	手元在庫	InventoryLevel.quantities[on_hand]	InventoryLevel.quantities(name: on_hand)を集計します。
low_stock_threshold	returned_metric	低在庫しきい値	MCP argument	低在庫判定に使うしきい値です。
low_stock_items	returned_entity	低在庫商品	InventoryItem / InventoryLevel	低在庫商品のsku、available、on_hand、committedを返します。
marketing_started_at	returned_dimension	イベント開始日時	MarketingEvent.startedAt	MarketingEvent.startedAtから取得する開始日時です。
marketing_ended_at	returned_dimension	イベント終了日時	MarketingEvent.endedAt	MarketingEvent.endedAtから取得する終了日時です。
marketing_type	returned_dimension	イベント種別	MarketingEvent.type	MarketingEvent.typeから取得するイベント種別です。
marketing_channel_type	returned_dimension	マーケティングチャネル	MarketingEvent.marketingChannelType	MarketingEvent.marketingChannelTypeから取得するチャネル種別です。
source_and_medium	returned_dimension	参照元 / メディア	MarketingEvent.sourceAndMedium	MarketingEvent.sourceAndMediumから取得します。
utm_campaign	returned_dimension	UTMキャンペーン	MarketingEvent.utmCampaign	MarketingEvent.utmCampaignから取得します。
utm_source	returned_dimension	UTMソース	MarketingEvent.utmSource	MarketingEvent.utmSourceから取得します。
utm_medium	returned_dimension	UTMメディア	MarketingEvent.utmMedium	MarketingEvent.utmMediumから取得します。
return_name	returned_dimension	返品番号	Return.name	Return.nameから取得する返品番号です。
return_status	returned_dimension	返品ステータス	Return.status	Return.statusから取得する返品ステータスです。
return_created_at	returned_dimension	返品作成日時	Return.createdAt	Return.createdAtから取得する返品作成日時です。
return_closed_at	returned_dimension	返品クローズ日時	Return.closedAt	Return.closedAtから取得する返品クローズ日時です。
return_line_quantity	returned_metric	返品明細数量	ReturnLineItem.quantity	ReturnLineItem.quantityから取得する返品数量です。
return_reason	returned_dimension	返品理由	ReturnLineItem.returnReason	ReturnLineItem.returnReasonから取得する返品理由です。
Order.id	api_candidate	注文ID	Order.id	注文詳細取得を拡張する場合に利用できるOrderのIDです。
Order.legacyResourceId	api_candidate	旧REST ID	Order.legacyResourceId	外部連携や移行時の突合に使える旧REST IDです。
Order.createdAt	api_candidate	注文作成日時	Order.createdAt	期間集計の基準になる注文作成日時です。
Order.updatedAt	api_candidate	注文更新日時	Order.updatedAt	差分同期に使える注文更新日時です。
Order.processedAt	api_candidate	注文処理日時	Order.processedAt	売上計上タイミングの整理に使える注文処理日時です。
Order.cancelledAt	api_candidate	キャンセル日時	Order.cancelledAt	キャンセル集計に使えるキャンセル日時です。
Order.cancelReason	api_candidate	キャンセル理由	Order.cancelReason	キャンセル要因分析に使える理由です。
Order.closedAt	api_candidate	注文クローズ日時	Order.closedAt	処理完了判定に使える日時です。
Order.confirmed	api_candidate	注文確定フラグ	Order.confirmed	未確定注文の除外に使えるフラグです。
Order.displayFinancialStatus	api_candidate	決済ステータス	Order.displayFinancialStatus	現在のMCP注文取得でも利用している決済ステータスです。
Order.displayFulfillmentStatus	api_candidate	フルフィルメントステータス	Order.displayFulfillmentStatus	現在のMCP注文取得でも利用している配送ステータスです。
Order.currentTotalPriceSet	api_candidate	現在の注文総額	Order.currentTotalPriceSet	返金・編集後の注文総額確認に使えます。
Order.subtotalPriceSet	api_candidate	小計	Order.subtotalPriceSet	税・送料・割引前後の分解に使えます。
Order.totalDiscountsSet	api_candidate	割引総額	Order.totalDiscountsSet	プロモーション分析に使えます。
Order.totalShippingPriceSet	api_candidate	送料総額	Order.totalShippingPriceSet	配送費分析に使えます。
Order.totalTaxSet	api_candidate	税額合計	Order.totalTaxSet	税区分の確認に使えます。
Order.taxesIncluded	api_candidate	税込みフラグ	Order.taxesIncluded	金額解釈に使える税込み価格フラグです。
Order.currencyCode	api_candidate	ストア通貨	Order.currencyCode	注文のストア通貨です。
Order.presentmentCurrencyCode	api_candidate	提示通貨	Order.presentmentCurrencyCode	購入者に提示された通貨です。
Order.paymentGatewayNames	api_candidate	決済ゲートウェイ	Order.paymentGatewayNames	決済手段別分析に使えます。
Order.sourceName	api_candidate	注文元	Order.sourceName	オンラインストア、POS、アプリなどの注文元です。
Order.tags	api_candidate	注文タグ	Order.tags	運用上のセグメント分類に使えます。
Order.riskLevel	api_candidate	不正リスク	Order.riskLevel	注文審査の分析に使えるリスクレベルです。
Order.lineItems	api_candidate	注文明細	Order.lineItems	商品別売上、数量、SKU分析に展開できます。
Order.transactions	api_candidate	決済トランザクション	Order.transactions	決済成功・失敗や返金の確認に使えます。
Order.fulfillments	api_candidate	フルフィルメント	Order.fulfillments	発送・配送処理情報に展開できます。
Order.refunds	api_candidate	返金	Order.refunds	返金額や返金理由の分析に使えます。
Order.returns	api_candidate	返品	Order.returns	返品率や返品理由の分析に使えます。
LineItem.id	api_candidate	明細ID	LineItem.id	注文明細単位の突合に使えます。
LineItem.title	api_candidate	明細商品名	LineItem.title	現在のMCP注文取得でも利用している商品名です。
LineItem.name	api_candidate	明細名	LineItem.name	バリアント表記を含む明細名です。
LineItem.quantity	api_candidate	明細数量	LineItem.quantity	現在のMCP注文取得でも利用している数量です。
LineItem.sku	api_candidate	明細SKU	LineItem.sku	商品マスタとの突合に使えます。
LineItem.vendor	api_candidate	明細ベンダー	LineItem.vendor	ブランド別分析に使えます。
LineItem.variantTitle	api_candidate	明細バリアント名	LineItem.variantTitle	サイズ・色別分析に使えます。
LineItem.discountedTotalSet	api_candidate	明細割引後金額	LineItem.discountedTotalSet	明細単位の割引後金額です。
LineItem.originalTotalSet	api_candidate	明細割引前金額	LineItem.originalTotalSet	明細単位の割引前金額です。
LineItem.taxLines	api_candidate	明細税情報	LineItem.taxLines	明細単位の税情報です。
LineItem.fulfillmentStatus	api_candidate	明細配送ステータス	LineItem.fulfillmentStatus	明細単位の配送ステータスです。
Product.id	api_candidate	商品ID	Product.id	商品マスタのキーになるIDです。
Product.title	api_candidate	商品名	Product.title	現在のMCP商品取得でも利用している商品名です。
Product.handle	api_candidate	商品ハンドル	Product.handle	現在のMCP商品取得でも利用しているURLハンドルです。
Product.descriptionHtml	api_candidate	商品説明HTML	Product.descriptionHtml	商品情報の要約に使える説明HTMLです。
Product.status	api_candidate	商品ステータス	Product.status	現在のMCP商品取得でも利用している公開ステータスです。
Product.productType	api_candidate	商品タイプ	Product.productType	現在のMCP商品取得でも利用している商品タイプです。
Product.vendor	api_candidate	ベンダー	Product.vendor	現在のMCP商品取得でも利用しているベンダーです。
Product.tags	api_candidate	商品タグ	Product.tags	カテゴリやキャンペーン分類に使えます。
Product.publishedAt	api_candidate	商品公開日時	Product.publishedAt	新商品分析に使えます。
Product.totalInventory	api_candidate	商品合計在庫	Product.totalInventory	商品単位の合計在庫数です。
Product.tracksInventory	api_candidate	在庫追跡フラグ	Product.tracksInventory	商品が在庫追跡対象かどうかです。
Product.variants	api_candidate	商品バリアント	Product.variants	SKU、価格、在庫に展開できます。
Product.options	api_candidate	商品オプション	Product.options	サイズ・色などの商品選択肢です。
Product.collections	api_candidate	所属コレクション	Product.collections	カテゴリ別分析に使えます。
Product.metafields	api_candidate	商品メタフィールド	Product.metafields	独自属性の分析に使えます。
Product.seo	api_candidate	SEO情報	Product.seo	SEOタイトル・説明に展開できます。
ProductVariant.id	api_candidate	バリアントID	ProductVariant.id	SKU単位のキーになるIDです。
ProductVariant.title	api_candidate	バリアント名	ProductVariant.title	現在のMCP商品取得でも利用しているバリアント名です。
ProductVariant.sku	api_candidate	バリアントSKU	ProductVariant.sku	現在のMCP商品取得でも利用しているSKUです。
ProductVariant.barcode	api_candidate	バーコード	ProductVariant.barcode	物流・在庫連携に使えます。
ProductVariant.price	api_candidate	販売価格	ProductVariant.price	現在のMCP商品取得でも利用している販売価格です。
ProductVariant.compareAtPrice	api_candidate	比較価格	ProductVariant.compareAtPrice	値引き表示の分析に使えます。
ProductVariant.inventoryQuantity	api_candidate	バリアント在庫数	ProductVariant.inventoryQuantity	バリアント単位の在庫数です。
ProductVariant.inventoryPolicy	api_candidate	在庫ポリシー	ProductVariant.inventoryPolicy	在庫切れ時の販売可否ポリシーです。
ProductVariant.taxable	api_candidate	課税フラグ	ProductVariant.taxable	課税対象かどうかです。
ProductVariant.selectedOptions	api_candidate	選択オプション	ProductVariant.selectedOptions	バリアントのサイズ・色などの選択肢です。
ProductVariant.inventoryItem	api_candidate	在庫アイテム	ProductVariant.inventoryItem	原価、HSコード、在庫拠点などに接続します。
ProductVariant.image	api_candidate	バリアント画像	ProductVariant.image	商品表示やLP改善分析に使えます。
InventoryItem.id	api_candidate	在庫アイテムID	InventoryItem.id	在庫マスタのキーになるIDです。
InventoryItem.sku	api_candidate	在庫SKU	InventoryItem.sku	現在のMCP在庫取得でも利用しているSKUです。
InventoryItem.tracked	api_candidate	在庫追跡フラグ	InventoryItem.tracked	現在のMCP在庫取得でも利用している追跡フラグです。
InventoryItem.requiresShipping	api_candidate	配送必要フラグ	InventoryItem.requiresShipping	配送が必要な商品かどうかです。
InventoryItem.countryCodeOfOrigin	api_candidate	原産国コード	InventoryItem.countryCodeOfOrigin	越境EC・通関情報に使えます。
InventoryItem.provinceCodeOfOrigin	api_candidate	原産地域コード	InventoryItem.provinceCodeOfOrigin	原産地域のコードです。
InventoryItem.harmonizedSystemCode	api_candidate	HSコード	InventoryItem.harmonizedSystemCode	越境配送・税関処理に使えます。
InventoryItem.unitCost	api_candidate	原価	InventoryItem.unitCost	粗利分析に使えます。
InventoryItem.inventoryLevels	api_candidate	拠点別在庫	InventoryItem.inventoryLevels	available、committed、on_handなどに展開します。
Customer.id	api_candidate	顧客ID	Customer.id	現在の標準サマリーでは個人識別子を返しません。
Customer.createdAt	api_candidate	顧客作成日時	Customer.createdAt	現在のMCP顧客集計でも利用している作成日時です。
Customer.updatedAt	api_candidate	顧客更新日時	Customer.updatedAt	現在のMCP顧客集計でも利用している更新日時です。
Customer.numberOfOrders	api_candidate	顧客注文数	Customer.numberOfOrders	現在のMCP顧客集計でも利用している累計注文数です。
Customer.amountSpent	api_candidate	顧客累計購入金額	Customer.amountSpent	現在のMCP顧客集計でも利用している累計購入金額です。
Customer.emailMarketingConsent.marketingState	api_candidate	メール同意状態	Customer.emailMarketingConsent.marketingState	現在のMCP顧客集計でも集計利用しています。
Customer.smsMarketingConsent.marketingState	api_candidate	SMS同意状態	Customer.smsMarketingConsent.marketingState	現在のMCP顧客集計でも集計利用しています。
Customer.email	pii_not_returned	顧客メールアドレス	Customer.email	取得可能ですが、標準MCPサマリーでは返しません。
Customer.phone	pii_not_returned	顧客電話番号	Customer.phone	取得可能ですが、標準MCPサマリーでは返しません。
Order.email	pii_not_returned	注文メールアドレス	Order.email	取得可能ですが、標準MCP注文取得では返しません。
Order.phone	pii_not_returned	注文電話番号	Order.phone	取得可能ですが、標準MCP注文取得では返しません。
Order.shippingAddress	pii_not_returned	配送先住所	Order.shippingAddress	取得可能ですが、標準MCP注文取得では返しません。
Order.billingAddress	pii_not_returned	請求先住所	Order.billingAddress	取得可能ですが、標準MCP注文取得では返しません。
MarketingEvent.type	api_candidate	イベント種別	MarketingEvent.type	現在のMCPイベント取得でも利用している種別です。
MarketingEvent.marketingChannelType	api_candidate	マーケティングチャネル	MarketingEvent.marketingChannelType	現在のMCPイベント取得でも利用しているチャネル種別です。
MarketingEvent.sourceAndMedium	api_candidate	参照元 / メディア	MarketingEvent.sourceAndMedium	現在のMCPイベント取得でも利用しています。
MarketingEvent.utmCampaign	api_candidate	UTMキャンペーン	MarketingEvent.utmCampaign	現在のMCPイベント取得でも利用しています。
MarketingEvent.utmSource	api_candidate	UTMソース	MarketingEvent.utmSource	現在のMCPイベント取得でも利用しています。
MarketingEvent.utmMedium	api_candidate	UTMメディア	MarketingEvent.utmMedium	現在のMCPイベント取得でも利用しています。
Return.name	api_candidate	返品番号	Return.name	現在のMCP返品集計でも利用している返品番号です。
Return.status	api_candidate	返品ステータス	Return.status	現在のMCP返品集計でも利用している返品ステータスです。
Return.createdAt	api_candidate	返品作成日時	Return.createdAt	現在のMCP返品集計でも利用している作成日時です。
Return.closedAt	api_candidate	返品クローズ日時	Return.closedAt	現在のMCP返品集計でも利用しているクローズ日時です。
ReturnLineItem.quantity	api_candidate	返品明細数量	ReturnLineItem.quantity	現在のMCP返品集計でも利用している返品数量です。
ReturnLineItem.returnReason	api_candidate	返品理由	ReturnLineItem.returnReason	現在のMCP返品集計でも利用している返品理由です。

BASE

EC / BASE OAuth

提供中

BASEのショップ情報、商品一覧、注文一覧、売上サマリーを読み取ります。個人情報は標準ツールでは返しません。

MCPツール

ツール	引数	戻り値	説明
base_shop_info	shop	shop_id / shop_name / shop_url	BASEショップ情報を取得する
base_products	limit, offset, visible	items	BASEの商品一覧を取得する
base_sales_summary	start_date, end_date	sales / orders / daily	BASE売上の日次サマリーを取得する
base_recent_orders	start_date, end_date, limit	orders	BASEの直近注文を取得する

フィールド

ID	型	表示名	媒体側API名	説明
shop_id	entity	ショップID	user.shop_id	BASEショップを識別するIDです。
shop_name	entity	ショップ名	user.shop_name	BASEショップの表示名です。
shop_url	entity	ショップURL	user.shop_url	BASEショップの公開URLです。
item_id	entity	商品ID	items.item_id	BASE商品を識別するIDです。
title	entity	商品名	items.title	商品名です。
price	metric	商品価格	items.price	商品の税込価格です。
stock	metric	在庫	items.stock / variations.variation_stock	商品またはバリエーションの在庫数です。
visible	dimension	公開状態	items.visible	商品が公開状態かどうかです。
identifier	entity	商品コード	items.identifier	ショップ側の商品コードです。
variation	entity	バリエーション	items.variations.variation	サイズや色などの商品バリエーションです。
unique_key	entity	注文キー	orders.unique_key	BASE注文を識別するキーです。
order_datetime	dimension	注文日時	orders.ordered	注文が発生した日時です。
payment	dimension	決済方法	orders.payment	クレジットカード、コンビニ決済などの決済方法です。
total_price	metric	注文金額	orders.total	注文単位の合計金額です。
dispatch_status	dimension	配送ステータス	orders.dispatch_status	未対応、入金待ち、配送中、対応済などの注文ステータスです。
cancelled_at	dimension	キャンセル日時	orders.cancelled	キャンセルされた日時です。標準集計ではキャンセル注文を売上から除外します。
pii_not_returned	privacy	返さない個人情報	orders.first_name / orders.last_name	BASE APIの注文レスポンスに含まれる氏名などはMCPツールの標準レスポンスでは返しません。

Rakuten RMS

EC / API key

提供中

楽天市場RMSの売上サマリーと注文一覧を読み取ります。

MCPツール

ツール	引数	戻り値	説明
rakuten_sales_summary	start_date, end_date	sales / orders	楽天の売上サマリーを取得する
rakuten_recent_orders	limit	orders	楽天の直近注文を取得する

フィールド

ID	型	表示名	媒体側API名	説明
orderNumber	returned_entity	注文番号	OrderModel.orderNumber	getOrderレスポンスの注文番号です。
orderDatetime	returned_dimension	注文日時	OrderModel.orderDatetime	注文日時です。
orderProgress	returned_dimension	注文進捗	OrderModel.orderProgress	注文確認待ち、発送待ち、発送済み、キャンセルなどの進捗コードです。
totalPrice	returned_metric	商品合計	OrderModel.totalPrice	注文金額計算に使う商品合計です。
couponAllTotalPrice	returned_metric	クーポン総額	OrderModel.couponAllTotalPrice	注文全体のクーポン値引き額です。
deliveryPrice	returned_metric	送料	OrderModel.deliveryPrice	注文送料です。
paymentCharge	returned_metric	決済手数料	OrderModel.paymentCharge	決済手数料です。
additionalFeeOccurAmountToUser	returned_metric	購入者追加負担	OrderModel.additionalFeeOccurAmountToUser	購入者側に発生する追加負担金額です。
goodsPrice	returned_metric	商品金額	OrderModel.goodsPrice	商品金額です。
requestPrice	returned_metric	請求金額	OrderModel.requestPrice	請求金額です。
couponShopPrice	returned_metric	店舗クーポン	OrderModel.couponShopPrice	店舗負担クーポン金額です。
couponOtherPrice	returned_metric	その他クーポン	OrderModel.couponOtherPrice	その他負担クーポン金額です。
additionalFeeOccurAmountToShop	returned_metric	店舗追加負担	OrderModel.additionalFeeOccurAmountToShop	店舗側に発生する追加負担金額です。
PointModel.usedPoint	returned_metric	利用ポイント	PointModel.usedPoint	注文で利用されたポイントです。
PackageModelList	api_model_field	配送パッケージ	OrderModel.PackageModelList	注文内の配送パッケージ配列です。
PackageModelList.ItemModelList	api_model_field	注文明細	PackageModel.ItemModelList	パッケージ内の注文明細配列です。
ItemModelList.itemName	returned_dimension	商品名	ItemModel.itemName	注文明細の商品名です。
ItemModelList.units	returned_metric	数量	ItemModel.units	注文明細の数量です。
ItemModelList.price	returned_metric	単価	ItemModel.price	注文明細の商品単価です。
shopOrderCfmDatetime	api_model_field	Shop Order Cfm Datetime	shopOrderCfmDatetime	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
orderFixDatetime	api_model_field	Order Fix Datetime	orderFixDatetime	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
shippingInstDatetime	api_model_field	Shipping Inst Datetime	shippingInstDatetime	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
shippingCmplRptDatetime	api_model_field	Shipping Cmpl Rpt Datetime	shippingCmplRptDatetime	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
cancelDueDate	api_model_field	Cancel Due Date	cancelDueDate	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
deliveryDate	api_model_field	Delivery Date	deliveryDate	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
deliveryTimeZone	api_model_field	Delivery Time Zone	deliveryTimeZone	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
settlementMethod	api_model_field	Settlement Method	settlementMethod	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
deliveryName	api_model_field	Delivery Name	deliveryName	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
postagePrice	api_model_field	Postage Price	postagePrice	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
deliveryTaxRate	api_model_field	Delivery Tax Rate	deliveryTaxRate	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
paymentMethod	api_model_field	Payment Method	paymentMethod	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
cardInstallmentDesc	api_model_field	Card Installment Desc	cardInstallmentDesc	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
asurakuFlag	api_model_field	Asuraku Flag	asurakuFlag	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
drugFlag	api_model_field	Drug Flag	drugFlag	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
dealFlag	api_model_field	Deal Flag	dealFlag	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
membershipType	api_model_field	Membership Type	membershipType	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
memo	api_model_field	Memo	memo	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
remarks	api_model_field	Remarks	remarks	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
mailPlugSentence	api_model_field	Mail Plug Sentence	mailPlugSentence	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
goodsTax	api_model_field	Goods Tax	goodsTax	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
postageTax	api_model_field	Postage Tax	postageTax	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
deliveryChargeTax	api_model_field	Delivery Charge Tax	deliveryChargeTax	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
couponTotalPrice	api_model_field	Coupon Total Price	couponTotalPrice	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
WrappingModelList	api_model_field	Wrapping Model List	WrappingModelList	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
SenderModel	pii_not_returned	Sender Model	SenderModel	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.basketId	api_model_field	Basket Id	PackageModelList.basketId	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.packageDeleteFlag	api_model_field	Package Delete Flag	PackageModelList.packageDeleteFlag	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.senderName	pii_not_returned	Sender Name	PackageModelList.senderName	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.postagePrice	api_model_field	Postage Price	PackageModelList.postagePrice	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.deliveryPrice	api_model_field	Delivery Price	PackageModelList.deliveryPrice	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.shippingNumber	api_model_field	Shipping Number	PackageModelList.shippingNumber	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
PackageModelList.deliveryCompany	api_model_field	Delivery Company	PackageModelList.deliveryCompany	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.itemId	api_model_field	Item Id	ItemModelList.itemId	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.manageNumber	api_model_field	Manage Number	ItemModelList.manageNumber	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.variantId	api_model_field	Variant Id	ItemModelList.variantId	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.itemNumber	api_model_field	Item Number	ItemModelList.itemNumber	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.itemURL	api_model_field	Item URL	ItemModelList.itemURL	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.selectedChoice	api_model_field	Selected Choice	ItemModelList.selectedChoice	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.pointRate	api_model_field	Point Rate	ItemModelList.pointRate	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ItemModelList.taxRate	api_model_field	Tax Rate	ItemModelList.taxRate	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
ordererModel	pii_not_returned	Orderer Model	ordererModel	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
receiverModel	pii_not_returned	Receiver Model	receiverModel	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
OrderModel.ordererModel.emailAddress	pii_not_returned	Email Address	OrderModel.ordererModel.emailAddress	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
OrderModel.ordererModel.phoneNumber	pii_not_returned	Phone Number	OrderModel.ordererModel.phoneNumber	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
OrderModel.receiverModel.address1	pii_not_returned	Address1	OrderModel.receiverModel.address1	楽天RMS Order APIの注文モデルで扱う候補フィールドです。
OrderModel.receiverModel.phoneNumber	pii_not_returned	Phone Number	OrderModel.receiverModel.phoneNumber	楽天RMS Order APIの注文モデルで扱う候補フィールドです。

Yahoo!ショッピング

EC / Yahoo! OAuth

準備中

Yahoo!ショッピングの売上サマリーと注文一覧を読み取ります。

MCPツール

ツール	引数	戻り値	説明
yahoo_sales_summary	start_date, end_date	sales / orders	Yahoo!ショッピングの売上サマリーを取得する
yahoo_recent_orders	limit	orders	Yahoo!ショッピングの直近注文を取得する

フィールド

ID	型	表示名	媒体側API名	説明
OrderId	official_order_field	注文ID	Yahoo!ショッピング OrderList Field (（^[a-zA-Z0-9-]+$）)	注文ID
Version	official_order_field	バージョン	Yahoo!ショッピング OrderList Field (（数値）)	カートや注文PF、購入データIFが変わったときにバージョンをあげます。
OriginalOrderId	official_order_field	受注時注文ID	Yahoo!ショッピング OrderList Field (（^[a-zA-Z0-9-]+$）)	受注処理した際の注文IDです。 ex）注文Aを注文B、注文Cに分割注文Cを注文D、注文Eに分割注文A、B、C、D、Eすべての受注時注文IDはA
ParentOrderId	official_order_field	分割元注文ID	Yahoo!ショッピング OrderList Field (（^[a-zA-Z0-9-]+$）)	注文分割した際の分割元注文IDです。（一番元となる受注時注文IDとは違う場合があります） ex）注文Aを注文B、注文Cに分割注文Cを注文D、注文Eに分割注文B、Cの分割元注文IDはA 注文D、Eの分割元注文IDはC 未分割注文ID（注文A）は未設定
DeviceType	official_order_field	デバイス情報	Yahoo!ショッピング OrderList Field (1 : PC 2 : ガラケー 3 : スマートフォン 4 : タブレット)	1＝PC,2＝ガラケー,・・スマフォ,アプリ等、固定はどのカートから入ってきたかで定義します。
IsActive	official_order_field	注文有効フラグ	Yahoo!ショッピング OrderList Field (false : 無効注文 true : 有効注文)	有効な注文として扱うか判定するフラグです。 ※現在この項目は利用できません
IsSeen	official_order_field	閲覧済みフラグ	Yahoo!ショッピング OrderList Field (false : 未閲覧 true : 閲覧済)	閲覧済みフラグ
IsSplit	official_order_field	分割フラグ	Yahoo!ショッピング OrderList Field (false : 未分割 true : 分割済)	分割元注文IDの場合は true : 分割済未分割、分割先注文IDは false : 未分割 ex）注文Aを注文B、注文Cに分割注文A：true 注文B：false 注文C：false
IsRoyalty	official_order_field	課金フラグ	Yahoo!ショッピング OrderList Field (false : 課金対象外 true : 課金対象)	課金対象かどうかを判定します。例えばテスト注文の場合はfalseを指定します。
IsSeller	official_order_field	管理者注文フラグ	Yahoo!ショッピング OrderList Field (false : 非管理者注文 true : 管理者注文)	セラーが登録Yahoo!IDで行った注文です。注文管理で表示します。
IsAffiliate	official_order_field	アフィリエイトフラグ	Yahoo!ショッピング OrderList Field (false : 非アフィリエイト経由注文 true : アフィリエイト経由注文)	アフィリエイト経由の注文かどうかの判定です。
IsRatingB2s	official_order_field	評価フラグ（Buyer⇒Seller）	Yahoo!ショッピング OrderList Field (false : 未評価 true : 評価済)	Seller評価済みかどうか判定します。
OrderTime	official_order_field	注文日時	Yahoo!ショッピング OrderList Field (YYYY-MM-DDTHH24:MI:SS（日本標準時）)	注文確定ボタン押下時落札時（＝操作日時）（例）2012-04-19T16:10:40
ExistMultiReleaseDate	official_order_field	複数発売日あり	Yahoo!ショッピング OrderList Field (false : 発売日1つのみ true : 発売日複数有り)	発売日が1つも設定されていない場合も「0」です。
ReleaseDate	official_order_field	注文（最長）発売日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	検索APIの取得項目のみで指定可能です。注文の（最長）発売日がセットされます。
LastUpdateTime	official_order_field	最終更新日時	Yahoo!ショッピング OrderList Field (（YYYY-MM-DDTHH24:MI:SS+09:00）（例）2012-04-19T16:10:40+09:00)	注文情報の最終更新日時です。
Suspect	official_order_field	悪戯フラグ	Yahoo!ショッピング OrderList Field (0 : 非悪戯注文 1 : 悪戯注文 2 : 悪戯解除済注文)	いたずら対象、非対象、解除済みを判定するフラグです。 3値持ちます。
OrderStatus	official_order_field	注文ステータス	Yahoo!ショッピング OrderList Field (0 : 未入力 1 : 予約中 2 : 処理中 3 : 保留 4 : キャンセル 5 : 完了 8 : 繰上げ同意待ち)	注文情報の状態を表すステータスです。新規注文は注文ステータス「処理中」かつ閲覧済みフラグ「false」で表現されます。新規予約は注文ステータス「予約中」かつ閲覧済みフラグ「false」で表現されます。
StoreStatus	official_order_field	ストアステータス	Yahoo!ショッピング OrderList Field (数値)	ストアが独自に設定可能なステータスです。（ステータス名はストアクリエイターProで管理します。）
RoyaltyFixTime	official_order_field	課金確定日時	Yahoo!ショッピング OrderList Field (（YYYY-MM-DDTHH24:MI:SS+09:00）（例）2012-04-19T16:10:40+09:00)	課金確定日時
PrintSlipFlag	official_order_field	注文伝票出力有無	Yahoo!ショッピング OrderList Field (false : 注文伝票未出力 true : 注文伝票出力済み)	注文伝票出力有無
PrintDeliveryFlag	official_order_field	納品書出力有無	Yahoo!ショッピング OrderList Field (false : 納品書未出力 true : 納品書出力済み)	納品書出力有無
PrintBillFlag	pii_not_returned	請求書出力有無	Yahoo!ショッピング OrderList Field (false : 請求書未出力 true : 請求書出力済み)	請求書出力有無
BuyerCommentsFlag	official_order_field	バイヤーコメント有無	Yahoo!ショッピング OrderList Field (false : バイヤーコメントなし true : バイヤーコメントあり)	ご要望欄入力がされている/されていないを表すフラグです。
PayStatus	official_order_field	入金ステータス	Yahoo!ショッピング OrderList Field (0 : 未入金 1 : 入金済)	受注、支払時に支払方法毎に注文PFで設定します。入金待ち入金済み
SettleStatus	official_order_field	決済ステータス	Yahoo!ショッピング OrderList Field (1 : 決済申込 2 : 支払待ち 3 : 支払完了 4 : 入金待ち 5 : 決済完了 6 : キャンセル 7 : 返金 8 : 有効期限切れ 9 : 決済申込中 10 : オーソリエラー 11 : 売上取消 12…	値は検索項目を参照してください。
PayType	official_order_field	支払い分類	Yahoo!ショッピング OrderList Field (0 : 後払い 1 : 前払い)	支払方法分類前払い、後払いを判定します。
PayMethod	official_order_field	支払い方法	Yahoo!ショッピング OrderList Field (（文字列） payment_決済ID)	お支払方法番号 payment_a1：クレジットカード決済 payment_a6：コンビニ決済（セブンイレブン） payment_a7：コンビニ決済（その他） payment_a8：モバイルSuica決済 payment_a9：dケータイ払い payment_a10： auかんたん決済 au PAY（auかんたん決済） payment_a11：ソフトバンクまとめて支払い payment_a15：ペイジー payment_a16：Yahoo!マネー/預金払い payment_a17：PayPay残高等 paymen…
PayMethodName	official_order_field	支払い方法名称	Yahoo!ショッピング OrderList Field (（文字列）支払方法)	お支払方法と別に名称を持ちます。Yahoo!決済名称、銀行振込の銀行名、ゆうちょなど。 2026/6/12追記 2026/7/16（木）リリース後の注文に関して名称が変更されます。（ ※7 ）リリース前の注文に関しては変更されませんのでご注意ください。
PayDate	official_order_field	入金日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	注文管理ツールで入力された入金日です。
SettleId	official_order_field	決済ID	Yahoo!ショッピング OrderList Field (（英数字ASCⅡ文字）英数字ASCII文字英文字は小文字)	NT決済ID、クレカ以外も同様です。
UseWallet	official_order_field	ウォレット利用有無	Yahoo!ショッピング OrderList Field (false : Wallet利用無し true : Wallet利用有り)	支払にWalletを利用した注文フラグです。 ※Wallet利用の範囲を定義する必要があります。
NeedBillSlip	pii_not_returned	請求書有無	Yahoo!ショッピング OrderList Field (キーなし : カートに設定なし false : 請求書不要 true : 請求書必要)	請求書有無
NeedDetailedSlip	official_order_field	明細書有無	Yahoo!ショッピング OrderList Field (キーなし : カートに設定なし false : 明細書不要 true : 明細書必要)	明細書有無伝票画面上では、「納品書」表記します。帳票出力でも「納品書」出力で、「明細書」が出力可能です。
NeedReceipt	official_order_field	領収書有無	Yahoo!ショッピング OrderList Field (キーなし : カートに設定なし false : 領収書不要 true : 領収書必要)	領収書有無
BillFirstName	pii_not_returned	ご請求先名前	Yahoo!ショッピング OrderList Field (（文字列）)	ご請求先名前ソーシャルギフト注文では"ソーシャルギフト利用者"固定になります。
BillFirstNameKana	pii_not_returned	ご請求先名前カナ	Yahoo!ショッピング OrderList Field (（文字列）)	ご請求先名前（フリガナ）ソーシャルギフト注文では"ソーシャルギフトリヨウシャ"固定になります。
BillLastName	pii_not_returned	ご請求先名字	Yahoo!ショッピング OrderList Field (（文字列）)	ご請求先名字ソーシャルギフト注文ではストア名になります。
BillLastNameKana	pii_not_returned	ご請求先名字カナ	Yahoo!ショッピング OrderList Field (（文字列）)	ご請求先名字（フリガナ）ソーシャルギフト注文ではストア名カナになります。
BillPrefecture	pii_not_returned	ご請求先都道府県	Yahoo!ショッピング OrderList Field (（文字列）)	ご請求先都道府県海外の場合「その他」が入ります。ソーシャルギフト注文ではストアのお問い合わせ住所の都道府県になります。
ShipStatus	pii_not_returned	出荷ステータス	Yahoo!ショッピング OrderList Field (0 : 出荷不可 1 : 出荷可 2 : 出荷処理中 3 : 出荷済み 4 : 着荷済み)	支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。
ShipMethod	pii_not_returned	配送方法	Yahoo!ショッピング OrderList Field (（文字列） postageN)	お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）ストアクリエイターProの配送設定順。
ShipMethodName	pii_not_returned	配送方法名	Yahoo!ショッピング OrderList Field (（文字列）)	配送方法名
ShipRequestDate	pii_not_returned	配送希望日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	配送希望日です。
ShipRequestTime	pii_not_returned	配送希望時間	Yahoo!ショッピング OrderList Field (（文字列）)	12:00～14:00など
ShipNotes	pii_not_returned	配送メモ	Yahoo!ショッピング OrderList Field (（文字列）)	注文管理ツールで入力された出荷の配送希望メモ入力内容です。
ShipCompanyCode	pii_not_returned	配送会社	Yahoo!ショッピング OrderList Field (（数値）)	配送会社コード 1000：その他 1001：ヤマト運輸 1002：佐川急便 1003：日本郵便 1004：西濃運輸 5001：店頭受け取り（一覧はこちら）
ReceiveShopCode	official_order_field	受取店舗コード	Yahoo!ショッピング OrderList Field (（文字列）)	受取店舗コード
ShipInvoiceNumber1	pii_not_returned	配送伝票番号１	Yahoo!ショッピング OrderList Field (（文字列）)	注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
ShipInvoiceNumber2	pii_not_returned	配送伝票番号2	Yahoo!ショッピング OrderList Field (（文字列）)	注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
ShipInvoiceNumberEmptyReason	pii_not_returned	伝票番号なし理由	Yahoo!ショッピング OrderList Field (（文字列）)	NULL：（未登録の状態） 101：メーカ等の在庫元からの直送品のため 102：発送不要の商品のため 103：店頭受け取り商品のため 104：配送会社から直接ご連絡のため 105：伝票番号が発行されない（追跡できない）配送方法のため
ShipUrl	pii_not_returned	配送会社URL	Yahoo!ショッピング OrderList Field (（文字列）)	配送会社URL
ArriveType	official_order_field	きょうつく、あすつく	Yahoo!ショッピング OrderList Field (0 : 通常 1 : きょうつく注文 2 : あすつく注文)	きょうつく注文、あすつく注文の場合の設定です。
ShipDate	pii_not_returned	出荷日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	注文管理ツールで入力された出荷日です。
NeedGiftWrap	official_order_field	ギフト包装有無	Yahoo!ショッピング OrderList Field (キーなし : カートに設定なし false : ギフト包装無し true : ギフト包装有り)	ギフト包装
NeedGiftWrapMessage	official_order_field	ギフトメッセージ有無	Yahoo!ショッピング OrderList Field (false : ギフトメッセージ無し true : ギフトメッセージ有り)	ギフトメッセージ有無
NeedGiftWrapPaper	official_order_field	のし有無	Yahoo!ショッピング OrderList Field (false : のし無し true : のし有りキーなし : カートに設定なし)	のしの有無
ShipFirstName	pii_not_returned	お届け先名前	Yahoo!ショッピング OrderList Field (（文字列）)	お届け先名前
ShipFirstNameKana	pii_not_returned	お届け先名前カナ	Yahoo!ショッピング OrderList Field (（文字列）)	お届け先名前（フリガナ）
ShipLastName	pii_not_returned	お届け先名字	Yahoo!ショッピング OrderList Field (（文字列）)	お届け先名字
ShipLastNameKana	pii_not_returned	お届け先名字カナ	Yahoo!ショッピング OrderList Field (（文字列）)	お届け先名字（フリガナ）
ShipPrefecture	pii_not_returned	お届け先都道府県	Yahoo!ショッピング OrderList Field (（文字列）)	お届け先都道府県海外の場合は「その他」として保存します。
PayCharge	official_order_field	手数料	Yahoo!ショッピング OrderList Field (（数値）)	セラーが設定した手数料（代引き手数料など）、Yahoo!決済の決済手数料は別です。
ShipCharge	pii_not_returned	送料	Yahoo!ショッピング OrderList Field (（数値）)	送料（送料無料クーポン値引き後の金額）
GiftWrapCharge	official_order_field	ギフト包装料	Yahoo!ショッピング OrderList Field (（数値）)	ギフト包装料
Discount	official_order_field	値引き	Yahoo!ショッピング OrderList Field (（数値）)	値引き
GiftCardDiscount	official_order_field	商品券利用額	Yahoo!ショッピング OrderList Field (（数値）)	利用された商品券の利用額です
UsePoint	official_order_field	利用ポイント合計	Yahoo!ショッピング OrderList Field (（数値）)	利用ポイント数、特典の一部利用もしくは商品券を利用した注文の場合は、その利用額がそれぞれ加算されます。
TotalPrice	official_order_field	合計金額	Yahoo!ショッピング OrderList Field (（数値）)	商品金額合計（税込） + ギフト包装料 + 送料 + 手数料 - 値引き - 利用ポイント数 - モールクーポン値引き額 - 特典の一部利用額 - 商品券利用額 + 調整額 ※ 注文検索APIの「TotalPrice（合計金額）」は、注文情報フィールドの「Total（請求金額合計）」と同じ値を表します。内訳は以下マニュアルも参照ください。ストアクリエイタProマニュアル：注文フィールド一覧の「Total」と「TotalPrice」の違いはなんですか
RefundTotalPrice	official_order_field	返金合計金額	Yahoo!ショッピング OrderList Field (（数値）)	注文キャンセル後取得可能
UsePointFixDate	official_order_field	利用ポイント確定日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	利用確定予定日 ※現在この項目は利用できません
IsUsePointFix	official_order_field	利用ポイント確定有無	Yahoo!ショッピング OrderList Field (false : 未確定 true : 確定済)	利用ポイントが確定処理を完了したかどうかを示します。 ※現在この項目は利用できません
IsGetPointFixAll	official_order_field	全付与ポイント確定有無	Yahoo!ショッピング OrderList Field (false : 未確定 true : 確定済)	全Lineの付与ポイントが確定処理を完了したかどうかを示します。
SellerId	official_order_field	セラーID	Yahoo!ショッピング OrderList Field (（文字列）)	セラーID
IsLogin	official_order_field	Yahoo! JAPAN IDログイン有無	Yahoo!ショッピング OrderList Field (false : ゲスト true : ログイン)	Yahoo! JAPAN IDでログインしているかを判定します。
PayNo	official_order_field	支払番号	Yahoo!ショッピング OrderList Field (（文字列）)	支払番号
PayNoIssueDate	official_order_field	支払番号発行日時	Yahoo!ショッピング OrderList Field (（YYYY-MM-DDTHH24:MI:SS+09:00）（例）2012-04-19T16:10:40+09:00)	支払番号発行日時
SellerType	official_order_field	セラー種別	Yahoo!ショッピング OrderList Field (1 : セラー 2 : セラー（個人出店者）)	セラー種別
IsPayManagement	official_order_field	代金支払い管理注文	Yahoo!ショッピング OrderList Field (false : 非代金支払い管理 true : 代金支払い管理)	代金支払い管理注文
ArrivalDate	official_order_field	着荷日	Yahoo!ショッピング OrderList Field (（YYYY-MM-DD）)	着荷日
TotalMallCouponDiscount	official_order_field	モールクーポン値引き額	Yahoo!ショッピング OrderList Field (（数値）)	モールクーポン値引き額
IsReadOnly	official_order_field	読み取り専用	Yahoo!ショッピング OrderList Field (（数値）)	1：読み取り専用（キャンセル受付注文） 0：読み書き可能
IsApplePay	official_order_field	ApplePay利用有無	Yahoo!ショッピング OrderList Field (false：ApplePay利用無し true：ApplePay利用有り)	支払にApplePayを利用した注文フラグです。 ※ ApplePay導入リリースで追加予定
IsFirstClassDrugIncludes	official_order_field	第1類医薬品フラグ	Yahoo!ショッピング OrderList Field (false、null：第1類医薬品を含まない注文 true：第1類医薬品を含む注文)	第1類医薬品を含む注文か判定します。
IsFirstClassDrugAgreement	official_order_field	第1類医薬品承諾フラグ	Yahoo!ショッピング OrderList Field (false、null：未承諾 true：承諾済み)	第1類医薬品を含む注文の承諾状況を判定します。
IsWelcomeGiftIncludes	official_order_field	無料プレゼント(ウェルカムギフト)含有フラグ	Yahoo!ショッピング OrderList Field (false/true)	false、null：無料プレゼント(ウェルカムギフト)を含まない注文 true：無料プレゼント(ウェルカムギフト)を含む注文
ReceiveSatelliteType	official_order_field	自宅外配送受取種別	Yahoo!ショッピング OrderList Field (数値)	自宅外配送の種別を判定します。 0,Null：通常配送 1：日本郵便自宅外配送 3：ヤマト自宅外配送（2025年10月中旬リリース予定）
ShipInstructType	pii_not_returned	出荷指示区分	Yahoo!ショッピング OrderList Field (数値)	0：対象外 1：直接連携 2：荷主経由 101：ヤマト運輸株式会社ピック＆デリバリー 102：ヤマト運輸株式会社フルフィルメント（API連携） 103：ヤマト運輸株式会社ピック＆デリバリー（連携外ストア） 104：ヤマト運輸株式会社フルフィルメント（マルチチャネル）
ShipInstructStatus	pii_not_returned	※ヤマトピック&デリバリー、フルフィルメント専用項目出荷指示ステータス	Yahoo!ショッピング OrderList Field (数値)	0：対象外 100：出荷指示受付前 101：出荷指示待ち 102：出荷キャンセル 103：出荷指示済み 104：出荷完了 105：着荷完了 106：配送不可
YamatoCoopStatus	official_order_field	※ヤマトピック&デリバリー、フルフィルメント専用項目ヤマト連携ステータス	Yahoo!ショッピング OrderList Field (数値)	null or 0 ：対象外、未連携 1：連携受付 2：連携処理中 3：連携済 4：連携キャンセル
ReceiveShopType	official_order_field	店頭注文種別	Yahoo!ショッピング OrderList Field (（数値）)	null or 0 ：通常注文 1：店頭受取 2：店頭在庫受取 3：店頭在庫発送
ReceiveShopName	official_order_field	配送元店頭名	Yahoo!ショッピング OrderList Field (文字列)	配送元店頭名
ExcellentDelivery	official_order_field	優良配送フラグ	Yahoo!ショッピング OrderList Field (（数値）)	0 : 優良配送でない 1 : 優良配送 2：翌日優良配送
IsEazy	official_order_field	EAZY注文フラグ置き配注文フラグ	Yahoo!ショッピング OrderList Field (null：リリース前注文 false： EAZY外注文置き配外注文 true： EAZY注文置き配注文)	EAZY注文フラグ置き配（EAZY、指定場所配送等）注文フラグ ※Yahoo!ショッピング提供の置き配を利用した場合もtrueになります。
EazyDeliveryCode	official_order_field	EAZYコード置き配コード	Yahoo!ショッピング OrderList Field (0-7)	EAZYコード置き配（EAZY、指定場所配送等）コード
EazyDeliveryName	official_order_field	EAZY受け取り場所名置き配受け取り場所名	Yahoo!ショッピング OrderList Field (対面受取（置き配を利用しない）玄関ドア前自宅宅配BOX ガスメーターBOX 物置車庫自転車かご建物内受付／管理人預け)	EAZY受け取り場所名置き配（EAZY、指定場所配送等）の置き配場所を文字列で表します。
FraudHoldStatus	official_order_field	不正保留ステータス	Yahoo!ショッピング OrderList Field (数値)	0 or null：不正リスク低 1：ルール保留審査中 2：ルール保留解除 3：ルール悪用確
PublicationTime	official_order_field	orderList公開日時	Yahoo!ショッピング OrderList Field (YYYY-MM-DDTHH24:MI:SS（日本標準時）)	不正保留解除時など、orderListから取得できるようになった時間がセットされます。
IsYahooAuctionOrder	official_order_field	Yahoo!オークション併売フラグ	Yahoo!ショッピング OrderList Field (true：Yahoo!オークション注文 false：Yahoo!オークション注文以外)	Yahoo!オークション注文であるかの判定フラグ
YahooAuctionMerchantId	official_order_field	Yahoo!オークション管理番号	Yahoo!ショッピング OrderList Field ((文字列)1234567890 ※下記の記号は使用可能 # & ( ) - . / _)	Yahoo!オークション管理番号
YahooAuctionId	official_order_field	オークションID	Yahoo!ショッピング OrderList Field ((文字列) y123456789)	オークションID
IsYahooAuctionDeferred	official_order_field	Yahoo!オークション購入後決済フラグ	Yahoo!ショッピング OrderList Field (true：購入後決済（※入札・落札後、購入手続きする形式） false or null：購入後決済以外)	Yahoo!オークション購入後決済フラグ
YahooAuctionCategoryType	official_order_field	Yahoo!オークションカテゴリ種別	Yahoo!ショッピング OrderList Field (0 or null：通常 1：自動車車体 2：バイク車体)	Yahoo!オークションカテゴリ種別
YahooAuctionBidType	official_order_field	Yahoo!オークション落札種別	Yahoo!ショッピング OrderList Field (0 or null：定額 1：競り(即決価格) 2：競り(通常))	Yahoo!オークション落札種別
YahooAuctionBundleType	official_order_field	Yahoo!オークション同梱タイプ	Yahoo!ショッピング OrderList Field (0 または null: 同梱ではないYahoo!オークション注文または Yahoo!オークションではない注文 1: 同梱注文)	Yahoo!オークション注文での同梱機能の利用状況
ItemYahooAucId	official_order_field	オークションID	Yahoo!ショッピング OrderList Field (8桁から11桁の英数字です。)	レスポンスではLine1の商品のデータしか返却されません。 1つ目（Line1）以外の対象を取得したい場合は注文詳細APIをご利用ください。
ItemYahooAucMerchantId	official_order_field	Yahoo!オークション管理番号	Yahoo!ショッピング OrderList Field (CDATA)	レスポンスではLine1の商品のデータしか返却されません。 1つ目（Line1）以外の対象を取得したい場合は注文詳細APIをご利用ください。
PayMethodChangeDeadline	official_order_field	支払い方法変更期限	Yahoo!ショッピング OrderList Field (YYYY-MM-DDTHH24 : mi : SS（日本標準時）)	オーソリエラー発生時点の翌日から7日後の23:59
IsPayMethodChangePossible	official_order_field	支払い方法変更可能フラグ	Yahoo!ショッピング OrderList Field (false：支払い方法変更不可 true：支払い方法変更可)	支払い方法が変更可能か判定するフラグです。 ※支払い方法変更が完了、支払い方法変更期限の超過、注文キャンセル状態になるとtrue→falseに更新されます。
YourTimesaleDiscount	official_order_field	あなただけのタイムセール値引価格	Yahoo!ショッピング OrderList Field (（数値）)	あなただけのタイムセール値引価格
GoodStoreStatus	official_order_field	優良店判定	Yahoo!ショッピング OrderList Field (0 or null：なし 1：優良店)	優良店を判別 ※2022/10以降予定
CurrentGoodStoreBenefitApply	official_order_field	注文時点の優良店特典適応状態	Yahoo!ショッピング OrderList Field (0 or null：なし 1：適応)	注文時点の優良店特典の適応状態を示す ※2022/10以降予定
CurrentPromoPkgApply	official_order_field	注文時点のプラン適応状況	Yahoo!ショッピング OrderList Field (0 or null：なし 1：適応)	注文時点のプラン適応状況を示す ※2022/10以降予定
IsSubscription	official_order_field	定期購入フラグ	Yahoo!ショッピング OrderList Field (null：定期購入注文ではない true：定期購入注文である)	定期購入契約の受注であることを示すフラグ
SubscriptionId	official_order_field	定期購入親ID	Yahoo!ショッピング OrderList Field (teiki-yyyyMMdd-ストアアカウント-ランダム英数8桁)	定期購入の大本のID このIDに対して定期購入された注文が紐付きます。初回の定期購入時のみ参照可能になるまで、注文日時から数分程度のタイムラグがありますのでご留意ください。
SubscriptionContinueCount	official_order_field	定期購入継続回数	Yahoo!ショッピング OrderList Field (（数値）)	同一の定期購入親IDでの定期購入継続回数
LineGiftOrderId	official_order_field	LINE注文ID ※LINE専用項目	Yahoo!ショッピング OrderList Field (（文字列）)	受注時に連携されたLINE注文ID
IsLineGiftOrder	official_order_field	LINE注文 ※LINE専用項目	Yahoo!ショッピング OrderList Field (false : LINE注文以外 true : LINE注文)	LINE注文かどうかを判定するフラグ
IsLineGiftShippable	pii_not_returned	LINE出荷可能フラグ ※LINE専用項目	Yahoo!ショッピング OrderList Field (false : LINE出荷不可 true : LINE出荷可能)	LINE注文が出荷可能状態であるかを判定するフラグ
ShippingDeadline	pii_not_returned	LINE発送期限 ※LINE専用項目	Yahoo!ショッピング OrderList Field (YYYY-MM-DDTHH24:mi:SS（日本標準時）)	LINE注文の発送期限
LineGiftCharge	official_order_field	LINE手数料 ※LINE専用項目	Yahoo!ショッピング OrderList Field (（数値）)	LINE注文の手数料
TotalImmediateBonusAmount	official_order_field	特典の一部利用合計額	Yahoo!ショッピング OrderList Field (（数値）)	特典の一部利用に対してのPayPayポイント利用額
TotalImmediateBonusRatio	official_order_field	特典の一部利用合計割合	Yahoo!ショッピング OrderList Field (（数値）)	特典の一部利用に対してのPayPayポイント利用割合
SocialGiftType	official_order_field	2byte（最大）	Yahoo!ショッピング OrderList Field (0：ソーシャルギフト以外の注文 1：URL共有により住所入力されたソーシャルギフト注文 2：購入者により住所入力されたソーシャルギフト注文)	2byte（最大）
IsLineCommerceTabOrder	official_order_field	LINEショッピングタブ経由注文フラグ	Yahoo!ショッピング OrderList Field (null or false：通常注文(nullは過去注文) true：LINEショッピングタブ経由注文)	LINEショッピングタブ経由注文かどうかの判定です。
XshoppingStoreType	official_order_field	Xショッピングストアタイプ	Yahoo!ショッピング OrderList Field (null：SHPストア ※今後追加の可能性がございます。)	Xショッピングのストアの区分値
OptionPartnerType	official_order_field	役務注文区分	Yahoo!ショッピング OrderList Field (0：通常注文 1：物品 2：役務)	役務注文区分

Amazon

EC / LWA OAuth

準備中

Amazon SP-APIの売上サマリーと注文一覧を読み取ります。

MCPツール

ツール	引数	戻り値	説明
amazon_sales_summary	start_date, end_date	sales / orders	Amazonの売上サマリーを取得する
amazon_recent_orders	limit	orders	Amazonの直近注文を取得する

フィールド

ID	型	表示名	媒体側API名	説明
Order.AmazonOrderId	api_schema_field	Amazon Order Id	SP-API Orders Order.AmazonOrderId (string)	An Amazon-defined order identifier, in 3-7-7 format.
Order.SellerOrderId	api_schema_field	Seller Order Id	SP-API Orders Order.SellerOrderId (string)	A seller-defined order identifier.
Order.PurchaseDate	api_schema_field	Purchase Date	SP-API Orders Order.PurchaseDate (string)	The date when the order was created.
Order.LastUpdateDate	api_schema_field	Last Update Date	SP-API Orders Order.LastUpdateDate (string)	The date when the order was last updated. __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01.
Order.OrderStatus	api_schema_field	Order Status	SP-API Orders Order.OrderStatus (string)	The current order status.
Order.FulfillmentChannel	api_schema_field	Fulfillment Channel	SP-API Orders Order.FulfillmentChannel (string)	Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).
Order.SalesChannel	api_schema_field	Sales Channel	SP-API Orders Order.SalesChannel (string)	The sales channel for the first item in the order.
Order.OrderChannel	api_schema_field	Order Channel	SP-API Orders Order.OrderChannel (string)	The order channel for the first item in the order.
Order.ShipServiceLevel	api_schema_field	Ship Service Level	SP-API Orders Order.ShipServiceLevel (string)	The order's shipment service level.
Order.OrderTotal	api_schema_field	Order Total	SP-API Orders Order.OrderTotal (object)	The total charge for this order.
Order.OrderTotal.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
Order.OrderTotal.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
Order.NumberOfItemsShipped	api_schema_field	Number Of Items Shipped	SP-API Orders Order.NumberOfItemsShipped (integer)	The number of items shipped.
Order.NumberOfItemsUnshipped	api_schema_field	Number Of Items Unshipped	SP-API Orders Order.NumberOfItemsUnshipped (integer)	The number of items unshipped.
Order.PaymentExecutionDetail	api_schema_field	Payment Execution Detail	SP-API Orders Order.PaymentExecutionDetail (object)	Information about the sub-payment methods for an order.
Order.PaymentMethod	api_schema_field	Payment Method	SP-API Orders Order.PaymentMethod (string)	The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get…
Order.PaymentMethodDetails	api_schema_field	Payment Method Details	SP-API Orders Order.PaymentMethodDetails (object)	A list of payment methods for the order.
Order.MarketplaceId	api_schema_field	Marketplace Id	SP-API Orders Order.MarketplaceId (string)	The identifier for the marketplace where the order was placed.
Order.ShipmentServiceLevelCategory	api_schema_field	Shipment Service Level Category	SP-API Orders Order.ShipmentServiceLevelCategory (string)	The shipment service level category for the order. Possible values: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`.
Order.EasyShipShipmentStatus	api_schema_field	Easy Ship Shipment Status	SP-API Orders Order.EasyShipShipmentStatus (object)	The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
Order.CbaDisplayableShippingLabel	api_schema_field	Cba Displayable Shipping Label	SP-API Orders Order.CbaDisplayableShippingLabel (string)	Custom ship label for Checkout by Amazon (CBA).
Order.OrderType	api_schema_field	Order Type	SP-API Orders Order.OrderType (string)	The order's type.
Order.EarliestShipDate	api_schema_field	Earliest Ship Date	SP-API Orders Order.EarliestShipDate (string)	The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `EarliestShipDate` might not be return…
Order.LatestShipDate	api_schema_field	Latest Ship Date	SP-API Orders Order.LatestShipDate (string)	The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. __Note__: `LatestShipDate` might not be returned f…
Order.EarliestDeliveryDate	api_schema_field	Earliest Delivery Date	SP-API Orders Order.EarliestDeliveryDate (string)	The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.
Order.LatestDeliveryDate	api_schema_field	Latest Delivery Date	SP-API Orders Order.LatestDeliveryDate (string)	The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pendi…
Order.IsBusinessOrder	api_schema_field	Is Business Order	SP-API Orders Order.IsBusinessOrder (boolean)	When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer.
Order.IsPrime	api_schema_field	Is Prime	SP-API Orders Order.IsPrime (boolean)	When true, the order is a seller-fulfilled Amazon Prime order.
Order.IsPremiumOrder	api_schema_field	Is Premium Order	SP-API Orders Order.IsPremiumOrder (boolean)	When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to "Premium Shipping Options" in the Seller Central Help for your marketplace.
Order.IsGlobalExpressEnabled	api_schema_field	Is Global Express Enabled	SP-API Orders Order.IsGlobalExpressEnabled (boolean)	When true, the order is a `GlobalExpress` order.
Order.ReplacedOrderId	api_schema_field	Replaced Order Id	SP-API Orders Order.ReplacedOrderId (string)	The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.
Order.IsReplacementOrder	api_schema_field	Is Replacement Order	SP-API Orders Order.IsReplacementOrder (boolean)	When true, this is a replacement order.
Order.PromiseResponseDueDate	api_schema_field	Promise Response Due Date	SP-API Orders Order.PromiseResponseDueDate (string)	Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders.
Order.IsEstimatedShipDateSet	api_schema_field	Is Estimated Ship Date Set	SP-API Orders Order.IsEstimatedShipDateSet (boolean)	When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders.
Order.IsSoldByAB	api_schema_field	Is Sold By AB	SP-API Orders Order.IsSoldByAB (boolean)	When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise pur…
Order.IsIBA	api_schema_field	Is IBA	SP-API Orders Order.IsIBA (boolean)	When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise pur…
Order.DefaultShipFromLocationAddress	api_schema_field	Default Ship From Location Address	SP-API Orders Order.DefaultShipFromLocationAddress (object)	The recommended location for the seller to ship the items from. It is calculated at checkout. The seller may or may not choose to ship from this location.
Order.DefaultShipFromLocationAddress.Name	pii_not_returned	Name	SP-API Orders Address.Name (string)	The name.
Order.DefaultShipFromLocationAddress.CompanyName	pii_not_returned	Company Name	SP-API Orders Address.CompanyName (string)	The company name of the recipient. Note: This attribute is only available for shipping address.
Order.DefaultShipFromLocationAddress.AddressLine1	pii_not_returned	Address Line1	SP-API Orders Address.AddressLine1 (string)	The street address.
Order.DefaultShipFromLocationAddress.AddressLine2	pii_not_returned	Address Line2	SP-API Orders Address.AddressLine2 (string)	Additional street address information, if required.
Order.DefaultShipFromLocationAddress.AddressLine3	pii_not_returned	Address Line3	SP-API Orders Address.AddressLine3 (string)	Additional street address information, if required.
Order.DefaultShipFromLocationAddress.City	api_schema_field	City	SP-API Orders Address.City (string)	The city.
Order.DefaultShipFromLocationAddress.County	api_schema_field	County	SP-API Orders Address.County (string)	The county.
Order.DefaultShipFromLocationAddress.District	api_schema_field	District	SP-API Orders Address.District (string)	The district.
Order.DefaultShipFromLocationAddress.StateOrRegion	api_schema_field	State Or Region	SP-API Orders Address.StateOrRegion (string)	The state or region.
Order.DefaultShipFromLocationAddress.Municipality	api_schema_field	Municipality	SP-API Orders Address.Municipality (string)	The municipality.
Order.DefaultShipFromLocationAddress.PostalCode	api_schema_field	Postal Code	SP-API Orders Address.PostalCode (string)	The postal code.
Order.DefaultShipFromLocationAddress.CountryCode	api_schema_field	Country Code	SP-API Orders Address.CountryCode (string)	The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
Order.DefaultShipFromLocationAddress.Phone	pii_not_returned	Phone	SP-API Orders Address.Phone (string)	The phone number of the buyer. Note: 1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed: a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shippe…
Order.DefaultShipFromLocationAddress.ExtendedFields	api_schema_field	Extended Fields	SP-API Orders Address.ExtendedFields (object)	Extended address fields for additional address components including the street name or number. Note: Available for grocery sellers and Brazil shipping addresses.
Order.DefaultShipFromLocationAddress.ExtendedFields.StreetName	pii_not_returned	Street Name	SP-API Orders AddressExtendedFields.StreetName (string)	The street name.
Order.DefaultShipFromLocationAddress.ExtendedFields.StreetNumber	api_schema_field	Street Number	SP-API Orders AddressExtendedFields.StreetNumber (string)	The house, building, or property number associated with the location's street address.
Order.DefaultShipFromLocationAddress.ExtendedFields.Complement	api_schema_field	Complement	SP-API Orders AddressExtendedFields.Complement (string)	The floor number/unit number in the building/private house number.
Order.DefaultShipFromLocationAddress.ExtendedFields.Neighborhood	api_schema_field	Neighborhood	SP-API Orders AddressExtendedFields.Neighborhood (string)	The neighborhood. This value is only used in some countries (such as Brazil).
Order.DefaultShipFromLocationAddress.ExtendedFields.GeoCoordinates	api_schema_field	Geo Coordinates	SP-API Orders AddressExtendedFields.GeoCoordinates (object)	Latitude and longitude coordinates for the shipping address using the WGS84 coordinate system. Note: Available for sellers that support geographic coordinates.
Order.DefaultShipFromLocationAddress.ExtendedFields.GeoCoordinates.Latitude	api_schema_field	Latitude	SP-API Orders GeoCoordinates.Latitude (number)	The latitude coordinate of the shipping address using the WGS84 coordinate system.
Order.DefaultShipFromLocationAddress.ExtendedFields.GeoCoordinates.Longitude	api_schema_field	Longitude	SP-API Orders GeoCoordinates.Longitude (number)	The longitude coordinate of the shipping address using the WGS84 coordinate system.
Order.DefaultShipFromLocationAddress.AddressType	api_schema_field	Address Type	SP-API Orders Address.AddressType (string)	The address type of the shipping address.
Order.BuyerInvoicePreference	api_schema_field	Buyer Invoice Preference	SP-API Orders Order.BuyerInvoicePreference (string)	The buyer's invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey. Note: This attribute is only available in the Turkey marketplace.
Order.BuyerTaxInformation	pii_not_returned	Buyer Tax Information	SP-API Orders Order.BuyerTaxInformation (object)	Contains the business invoice tax information. Sellers could use this data to issue electronic invoices for business orders in Turkey. Note: 1. This attribute is only available in the Turkey marketplace for the orders that `BuyerInvoicePreference` is BUSI…
Order.BuyerTaxInformation.BuyerLegalCompanyName	pii_not_returned	Buyer Legal Company Name	SP-API Orders BuyerTaxInformation.BuyerLegalCompanyName (string)	Business buyer's company legal name.
Order.BuyerTaxInformation.BuyerBusinessAddress	pii_not_returned	Buyer Business Address	SP-API Orders BuyerTaxInformation.BuyerBusinessAddress (string)	Business buyer's address.
Order.BuyerTaxInformation.BuyerTaxRegistrationId	pii_not_returned	Buyer Tax Registration Id	SP-API Orders BuyerTaxInformation.BuyerTaxRegistrationId (string)	Business buyer's tax registration ID.
Order.BuyerTaxInformation.BuyerTaxOffice	pii_not_returned	Buyer Tax Office	SP-API Orders BuyerTaxInformation.BuyerTaxOffice (string)	Business buyer's tax office.
Order.FulfillmentInstruction	api_schema_field	Fulfillment Instruction	SP-API Orders Order.FulfillmentInstruction (object)	Contains the instructions about the fulfillment, such as the location from where you want the order filled.
Order.FulfillmentInstruction.FulfillmentSupplySourceId	api_schema_field	Fulfillment Supply Source Id	SP-API Orders FulfillmentInstruction.FulfillmentSupplySourceId (string)	The `sourceId` of the location from where you want the order fulfilled.
Order.IsISPU	api_schema_field	Is ISPU	SP-API Orders Order.IsISPU (boolean)	When true, this order is marked to be picked up from a store rather than delivered.
Order.IsAccessPointOrder	api_schema_field	Is Access Point Order	SP-API Orders Order.IsAccessPointOrder (boolean)	When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers.
Order.MarketplaceTaxInfo	pii_not_returned	Marketplace Tax Info	SP-API Orders Order.MarketplaceTaxInfo (object)	Tax information about the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. Note: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` sta…
Order.MarketplaceTaxInfo.TaxClassifications	pii_not_returned	Tax Classifications	SP-API Orders MarketplaceTaxInfo.TaxClassifications (array)	A list of tax classifications that apply to the order.
Order.MarketplaceTaxInfo.TaxClassifications.Name	pii_not_returned	Name	SP-API Orders TaxClassification.Name (string)	The type of tax.
Order.MarketplaceTaxInfo.TaxClassifications.Value	pii_not_returned	Value	SP-API Orders TaxClassification.Value (string)	The buyer's tax identifier.
Order.SellerDisplayName	pii_not_returned	Seller Display Name	SP-API Orders Order.SellerDisplayName (string)	The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. Note: This attribute is only available in the Brazil marketplace for the orders with `Pending`…
Order.ShippingAddress	pii_not_returned	Shipping Address	SP-API Orders Order.ShippingAddress (object)	The shipping address for the order. Note: 1. `ShippingAddress` is only available for orders with the following status values: Unshipped, `PartiallyShipped`, Shipped and `InvoiceUnconfirmed`. 2. The `ShippingAddress` contains restricted data. Use the Restr…
Order.ShippingAddress.Name	pii_not_returned	Name	SP-API Orders Address.Name (string)	The name.
Order.ShippingAddress.CompanyName	pii_not_returned	Company Name	SP-API Orders Address.CompanyName (string)	The company name of the recipient. Note: This attribute is only available for shipping address.
Order.ShippingAddress.AddressLine1	pii_not_returned	Address Line1	SP-API Orders Address.AddressLine1 (string)	The street address.
Order.ShippingAddress.AddressLine2	pii_not_returned	Address Line2	SP-API Orders Address.AddressLine2 (string)	Additional street address information, if required.
Order.ShippingAddress.AddressLine3	pii_not_returned	Address Line3	SP-API Orders Address.AddressLine3 (string)	Additional street address information, if required.
Order.ShippingAddress.City	pii_not_returned	City	SP-API Orders Address.City (string)	The city.
Order.ShippingAddress.County	pii_not_returned	County	SP-API Orders Address.County (string)	The county.
Order.ShippingAddress.District	pii_not_returned	District	SP-API Orders Address.District (string)	The district.
Order.ShippingAddress.StateOrRegion	pii_not_returned	State Or Region	SP-API Orders Address.StateOrRegion (string)	The state or region.
Order.ShippingAddress.Municipality	pii_not_returned	Municipality	SP-API Orders Address.Municipality (string)	The municipality.
Order.ShippingAddress.PostalCode	pii_not_returned	Postal Code	SP-API Orders Address.PostalCode (string)	The postal code.
Order.ShippingAddress.CountryCode	pii_not_returned	Country Code	SP-API Orders Address.CountryCode (string)	The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
Order.ShippingAddress.Phone	pii_not_returned	Phone	SP-API Orders Address.Phone (string)	The phone number of the buyer. Note: 1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed: a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shippe…
Order.ShippingAddress.ExtendedFields	pii_not_returned	Extended Fields	SP-API Orders Address.ExtendedFields (object)	Extended address fields for additional address components including the street name or number. Note: Available for grocery sellers and Brazil shipping addresses.
Order.ShippingAddress.ExtendedFields.StreetName	pii_not_returned	Street Name	SP-API Orders AddressExtendedFields.StreetName (string)	The street name.
Order.ShippingAddress.ExtendedFields.StreetNumber	pii_not_returned	Street Number	SP-API Orders AddressExtendedFields.StreetNumber (string)	The house, building, or property number associated with the location's street address.
Order.ShippingAddress.ExtendedFields.Complement	pii_not_returned	Complement	SP-API Orders AddressExtendedFields.Complement (string)	The floor number/unit number in the building/private house number.
Order.ShippingAddress.ExtendedFields.Neighborhood	pii_not_returned	Neighborhood	SP-API Orders AddressExtendedFields.Neighborhood (string)	The neighborhood. This value is only used in some countries (such as Brazil).
Order.ShippingAddress.ExtendedFields.GeoCoordinates	pii_not_returned	Geo Coordinates	SP-API Orders AddressExtendedFields.GeoCoordinates (object)	Latitude and longitude coordinates for the shipping address using the WGS84 coordinate system. Note: Available for sellers that support geographic coordinates.
Order.ShippingAddress.ExtendedFields.GeoCoordinates.Latitude	pii_not_returned	Latitude	SP-API Orders GeoCoordinates.Latitude (number)	The latitude coordinate of the shipping address using the WGS84 coordinate system.
Order.ShippingAddress.ExtendedFields.GeoCoordinates.Longitude	pii_not_returned	Longitude	SP-API Orders GeoCoordinates.Longitude (number)	The longitude coordinate of the shipping address using the WGS84 coordinate system.
Order.ShippingAddress.AddressType	pii_not_returned	Address Type	SP-API Orders Address.AddressType (string)	The address type of the shipping address.
Order.BuyerInfo	api_schema_field	Buyer Info	SP-API Orders Order.BuyerInfo (object)	Buyer information. Note: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerName`, `BuyerTaxInfo`, and `PurchaseOrderNumber`.
Order.BuyerInfo.BuyerEmail	pii_not_returned	Buyer Email	SP-API Orders BuyerInfo.BuyerEmail (string)	The anonymized email address of the buyer.
Order.BuyerInfo.BuyerName	pii_not_returned	Buyer Name	SP-API Orders BuyerInfo.BuyerName (string)	The buyer name or the recipient name.
Order.BuyerInfo.BuyerCounty	pii_not_returned	Buyer County	SP-API Orders BuyerInfo.BuyerCounty (string)	The county of the buyer. Note: This attribute is only available in the Brazil marketplace.
Order.BuyerInfo.BuyerTaxInfo	pii_not_returned	Buyer Tax Info	SP-API Orders BuyerInfo.BuyerTaxInfo (object)	Tax information about the buyer. Sellers could use this data to issue electronic invoices for business orders. Note: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces.
Order.BuyerInfo.BuyerTaxInfo.CompanyLegalName	pii_not_returned	Company Legal Name	SP-API Orders BuyerTaxInfo.CompanyLegalName (string)	The legal name of the company.
Order.BuyerInfo.BuyerTaxInfo.TaxingRegion	pii_not_returned	Taxing Region	SP-API Orders BuyerTaxInfo.TaxingRegion (string)	The country or region imposing the tax.
Order.BuyerInfo.BuyerTaxInfo.TaxClassifications	pii_not_returned	Tax Classifications	SP-API Orders BuyerTaxInfo.TaxClassifications (array)	A list of tax classifications that apply to the order.
Order.BuyerInfo.BuyerTaxInfo.TaxClassifications.Name	pii_not_returned	Name	SP-API Orders TaxClassification.Name (string)	The type of tax.
Order.BuyerInfo.BuyerTaxInfo.TaxClassifications.Value	pii_not_returned	Value	SP-API Orders TaxClassification.Value (string)	The buyer's tax identifier.
Order.BuyerInfo.PurchaseOrderNumber	api_schema_field	Purchase Order Number	SP-API Orders BuyerInfo.PurchaseOrderNumber (string)	The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
Order.AutomatedShippingSettings	api_schema_field	Automated Shipping Settings	SP-API Orders Order.AutomatedShippingSettings (object)	Contains information regarding the Shipping Settings Automaton program, such as whether the order's shipping settings were generated automatically, and what those settings are.
Order.AutomatedShippingSettings.HasAutomatedShippingSettings	api_schema_field	Has Automated Shipping Settings	SP-API Orders AutomatedShippingSettings.HasAutomatedShippingSettings (boolean)	When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
Order.AutomatedShippingSettings.AutomatedCarrier	api_schema_field	Automated Carrier	SP-API Orders AutomatedShippingSettings.AutomatedCarrier (string)	Auto-generated carrier for SSA orders.
Order.AutomatedShippingSettings.AutomatedShipMethod	api_schema_field	Automated Ship Method	SP-API Orders AutomatedShippingSettings.AutomatedShipMethod (string)	Auto-generated ship method for SSA orders.
Order.HasRegulatedItems	api_schema_field	Has Regulated Items	SP-API Orders Order.HasRegulatedItems (boolean)	Whether the order contains regulated items which may require additional approval steps before being fulfilled.
Order.ElectronicInvoiceStatus	api_schema_field	Electronic Invoice Status	SP-API Orders Order.ElectronicInvoiceStatus (object)	The status of the electronic invoice.
OrderItem.ASIN	api_schema_field	ASIN	SP-API Orders OrderItem.ASIN (string)	The item's Amazon Standard Identification Number (ASIN).
OrderItem.SellerSKU	api_schema_field	Seller SKU	SP-API Orders OrderItem.SellerSKU (string)	The item's seller stock keeping unit (SKU).
OrderItem.OrderItemId	api_schema_field	Order Item Id	SP-API Orders OrderItem.OrderItemId (string)	An Amazon-defined order item identifier.
OrderItem.AssociatedItems	api_schema_field	Associated Items	SP-API Orders OrderItem.AssociatedItems (array)	A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.
OrderItem.AssociatedItems.OrderId	api_schema_field	Order Id	SP-API Orders AssociatedItem.OrderId (string)	The order item's order identifier, in 3-7-7 format.
OrderItem.AssociatedItems.OrderItemId	api_schema_field	Order Item Id	SP-API Orders AssociatedItem.OrderItemId (string)	An Amazon-defined item identifier for the associated item.
OrderItem.AssociatedItems.AssociationType	api_schema_field	Association Type	SP-API Orders AssociatedItem.AssociationType (object)	OrderItem.AssociatedItems.AssociationType
OrderItem.Title	api_schema_field	Title	SP-API Orders OrderItem.Title (string)	The item's name.
OrderItem.QuantityOrdered	api_schema_field	Quantity Ordered	SP-API Orders OrderItem.QuantityOrdered (integer)	The number of items in the order.
OrderItem.QuantityShipped	api_schema_field	Quantity Shipped	SP-API Orders OrderItem.QuantityShipped (integer)	The number of items shipped.
OrderItem.ProductInfo	api_schema_field	Product Info	SP-API Orders OrderItem.ProductInfo (object)	The item's product information.
OrderItem.ProductInfo.NumberOfItems	api_schema_field	Number Of Items	SP-API Orders ProductInfoDetail.NumberOfItems (string)	The total number of items that are included in the ASIN.
OrderItem.PointsGranted	api_schema_field	Points Granted	SP-API Orders OrderItem.PointsGranted (object)	The number and value of Amazon Points granted with the purchase of an item.
OrderItem.PointsGranted.PointsNumber	api_schema_field	Points Number	SP-API Orders PointsGrantedDetail.PointsNumber (integer)	The number of Amazon Points granted with the purchase of an item.
OrderItem.PointsGranted.PointsMonetaryValue	api_schema_field	Points Monetary Value	SP-API Orders PointsGrantedDetail.PointsMonetaryValue (object)	The monetary value of the Amazon Points granted.
OrderItem.PointsGranted.PointsMonetaryValue.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.PointsGranted.PointsMonetaryValue.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ItemPrice	api_schema_field	Item Price	SP-API Orders OrderItem.ItemPrice (object)	The selling price of the order item. Note that an order item is an item and a quantity. This means that the value of `ItemPrice` is equal to the selling price of the item multiplied by the quantity ordered. `ItemPrice` excludes `ShippingPrice` and GiftWrapPri…
OrderItem.ItemPrice.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ItemPrice.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ShippingPrice	api_schema_field	Shipping Price	SP-API Orders OrderItem.ShippingPrice (object)	The item's shipping price.
OrderItem.ShippingPrice.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ShippingPrice.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ItemTax	api_schema_field	Item Tax	SP-API Orders OrderItem.ItemTax (object)	The tax on the item price.
OrderItem.ItemTax.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ItemTax.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ShippingTax	api_schema_field	Shipping Tax	SP-API Orders OrderItem.ShippingTax (object)	The tax on the shipping price.
OrderItem.ShippingTax.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ShippingTax.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ShippingDiscount	api_schema_field	Shipping Discount	SP-API Orders OrderItem.ShippingDiscount (object)	The discount on the shipping price.
OrderItem.ShippingDiscount.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ShippingDiscount.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.ShippingDiscountTax	api_schema_field	Shipping Discount Tax	SP-API Orders OrderItem.ShippingDiscountTax (object)	The tax on the discount on the shipping price.
OrderItem.ShippingDiscountTax.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.ShippingDiscountTax.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.PromotionDiscount	api_schema_field	Promotion Discount	SP-API Orders OrderItem.PromotionDiscount (object)	The total of all promotional discounts in the offer.
OrderItem.PromotionDiscount.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.PromotionDiscount.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.PromotionDiscountTax	api_schema_field	Promotion Discount Tax	SP-API Orders OrderItem.PromotionDiscountTax (object)	The tax on the total of all promotional discounts in the offer.
OrderItem.PromotionDiscountTax.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.PromotionDiscountTax.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.PromotionIds	api_schema_field	Promotion Ids	SP-API Orders OrderItem.PromotionIds (object)	OrderItem.PromotionIds
OrderItem.CODFee	api_schema_field	CODFee	SP-API Orders OrderItem.CODFee (object)	The fee charged for COD service.
OrderItem.CODFee.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.CODFee.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.CODFeeDiscount	api_schema_field	CODFee Discount	SP-API Orders OrderItem.CODFeeDiscount (object)	The discount on the COD fee.
OrderItem.CODFeeDiscount.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.CODFeeDiscount.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.IsGift	api_schema_field	Is Gift	SP-API Orders OrderItem.IsGift (string)	Indicates whether the item is a gift. Possible values: `true` and `false`.
OrderItem.ConditionNote	api_schema_field	Condition Note	SP-API Orders OrderItem.ConditionNote (string)	The condition of the item, as described by the seller.
OrderItem.ConditionId	api_schema_field	Condition Id	SP-API Orders OrderItem.ConditionId (string)	The condition of the item. Possible values: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`.
OrderItem.ConditionSubtypeId	api_schema_field	Condition Subtype Id	SP-API Orders OrderItem.ConditionSubtypeId (string)	The subcondition of the item. Possible values: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`.
OrderItem.ScheduledDeliveryStartDate	api_schema_field	Scheduled Delivery Start Date	SP-API Orders OrderItem.ScheduledDeliveryStartDate (string)	The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
OrderItem.ScheduledDeliveryEndDate	api_schema_field	Scheduled Delivery End Date	SP-API Orders OrderItem.ScheduledDeliveryEndDate (string)	The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
OrderItem.PriceDesignation	api_schema_field	Price Designation	SP-API Orders OrderItem.PriceDesignation (string)	Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Po…
OrderItem.TaxCollection	api_schema_field	Tax Collection	SP-API Orders OrderItem.TaxCollection (object)	Information about withheld taxes.
OrderItem.TaxCollection.Model	api_schema_field	Model	SP-API Orders TaxCollection.Model (string)	The tax collection model applied to the item.
OrderItem.TaxCollection.ResponsibleParty	api_schema_field	Responsible Party	SP-API Orders TaxCollection.ResponsibleParty (string)	The party responsible for withholding the taxes and remitting them to the taxing authority.
OrderItem.SerialNumberRequired	api_schema_field	Serial Number Required	SP-API Orders OrderItem.SerialNumberRequired (boolean)	When true, the product type for this item has a serial number. Only returned for Amazon Easy Ship orders.
OrderItem.IsTransparency	api_schema_field	Is Transparency	SP-API Orders OrderItem.IsTransparency (boolean)	When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by: 1D or 2D Barcode: This has a T logo. Submit either the 29-character alpha-numeric identifier beginning with AZ or ZA, or the…
OrderItem.IossNumber	api_schema_field	Ioss Number	SP-API Orders OrderItem.IossNumber (string)	The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
OrderItem.StoreChainStoreId	api_schema_field	Store Chain Store Id	SP-API Orders OrderItem.StoreChainStoreId (string)	The store chain store identifier. Linked to a specific store in a store chain.
OrderItem.DeemedResellerCategory	api_schema_field	Deemed Reseller Category	SP-API Orders OrderItem.DeemedResellerCategory (string)	The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.
OrderItem.BuyerInfo	api_schema_field	Buyer Info	SP-API Orders OrderItem.BuyerInfo (object)	A single item's buyer information. Note: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerCustomizedInfo` and `GiftMessageText`.
OrderItem.BuyerInfo.BuyerCustomizedInfo	api_schema_field	Buyer Customized Info	SP-API Orders ItemBuyerInfo.BuyerCustomizedInfo (object)	Buyer information for custom orders from the Amazon Custom program. Note: This attribute is only available for MFN (fulfilled by seller) orders.
OrderItem.BuyerInfo.BuyerCustomizedInfo.CustomizedURL	api_schema_field	Customized URL	SP-API Orders BuyerCustomizedInfoDetail.CustomizedURL (string)	The location of a ZIP file containing Amazon Custom data.
OrderItem.BuyerInfo.GiftWrapPrice	api_schema_field	Gift Wrap Price	SP-API Orders ItemBuyerInfo.GiftWrapPrice (object)	The gift wrap price of the item.
OrderItem.BuyerInfo.GiftWrapPrice.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.BuyerInfo.GiftWrapPrice.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.BuyerInfo.GiftWrapTax	api_schema_field	Gift Wrap Tax	SP-API Orders ItemBuyerInfo.GiftWrapTax (object)	The tax on the gift wrap price.
OrderItem.BuyerInfo.GiftWrapTax.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
OrderItem.BuyerInfo.GiftWrapTax.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
OrderItem.BuyerInfo.GiftMessageText	api_schema_field	Gift Message Text	SP-API Orders ItemBuyerInfo.GiftMessageText (string)	A gift message provided by the buyer. Note: This attribute is only available for MFN (fulfilled by seller) orders.
OrderItem.BuyerInfo.GiftWrapLevel	api_schema_field	Gift Wrap Level	SP-API Orders ItemBuyerInfo.GiftWrapLevel (string)	The gift wrap level specified by the buyer.
OrderItem.BuyerRequestedCancel	api_schema_field	Buyer Requested Cancel	SP-API Orders OrderItem.BuyerRequestedCancel (object)	Information about whether or not a buyer requested cancellation.
OrderItem.BuyerRequestedCancel.IsBuyerRequestedCancel	api_schema_field	Is Buyer Requested Cancel	SP-API Orders BuyerRequestedCancel.IsBuyerRequestedCancel (string)	Indicate whether the buyer has requested cancellation. Possible Values: `true`, `false`.
OrderItem.BuyerRequestedCancel.BuyerCancelReason	api_schema_field	Buyer Cancel Reason	SP-API Orders BuyerRequestedCancel.BuyerCancelReason (string)	The reason that the buyer requested cancellation.
OrderItem.SerialNumbers	api_schema_field	Serial Numbers	SP-API Orders OrderItem.SerialNumbers (array)	A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
OrderItem.SubstitutionPreferences	api_schema_field	Substitution Preferences	SP-API Orders OrderItem.SubstitutionPreferences (object)	Substitution preferences for the order item. This is an optional field that is only present if a seller supports substitutions, as is the case with some grocery sellers.
OrderItem.SubstitutionPreferences.SubstitutionType	api_schema_field	Substitution Type	SP-API Orders SubstitutionPreferences.SubstitutionType (string)	The type of substitution that these preferences represent.
OrderItem.SubstitutionPreferences.SubstitutionOptions	api_schema_field	Substitution Options	SP-API Orders SubstitutionPreferences.SubstitutionOptions (object)	Substitution options for the order item.
OrderItem.Measurement	api_schema_field	Measurement	SP-API Orders OrderItem.Measurement (object)	Measurement information for the order item.
OrderItem.Measurement.Unit	api_schema_field	Unit	SP-API Orders Measurement.Unit (string)	The unit of measure.
OrderItem.Measurement.Value	api_schema_field	Value	SP-API Orders Measurement.Value (number)	The measurement value.
OrderItem.ShippingConstraints	api_schema_field	Shipping Constraints	SP-API Orders OrderItem.ShippingConstraints (object)	Shipping constraints applicable to this order.
OrderItem.ShippingConstraints.PalletDelivery	api_schema_field	Pallet Delivery	SP-API Orders ShippingConstraints.PalletDelivery (object)	Indicates if the line item needs to be delivered by pallet.
OrderItem.ShippingConstraints.SignatureConfirmation	api_schema_field	Signature Confirmation	SP-API Orders ShippingConstraints.SignatureConfirmation (object)	Indicates that the recipient of the line item must sign to confirm its delivery.
OrderItem.ShippingConstraints.RecipientIdentityVerification	api_schema_field	Recipient Identity Verification	SP-API Orders ShippingConstraints.RecipientIdentityVerification (object)	Indicates that the person receiving the line item must be the same as the intended recipient of the order.
OrderItem.ShippingConstraints.RecipientAgeVerification	api_schema_field	Recipient Age Verification	SP-API Orders ShippingConstraints.RecipientAgeVerification (object)	Indicates that the carrier must confirm the recipient is of the legal age to receive the line item upon delivery.
OrderItem.AmazonPrograms	api_schema_field	Amazon Programs	SP-API Orders OrderItem.AmazonPrograms (object)	Contains the list of programs that are associated with an item.
OrderItem.AmazonPrograms.Programs	api_schema_field	Programs	SP-API Orders AmazonPrograms.Programs (array)	A list of the programs that Amazon associates with the order item. Possible values: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
Money.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
Money.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
Address.Name	pii_not_returned	Name	SP-API Orders Address.Name (string)	The name.
Address.CompanyName	pii_not_returned	Company Name	SP-API Orders Address.CompanyName (string)	The company name of the recipient. Note: This attribute is only available for shipping address.
Address.AddressLine1	pii_not_returned	Address Line1	SP-API Orders Address.AddressLine1 (string)	The street address.
Address.AddressLine2	pii_not_returned	Address Line2	SP-API Orders Address.AddressLine2 (string)	Additional street address information, if required.
Address.AddressLine3	pii_not_returned	Address Line3	SP-API Orders Address.AddressLine3 (string)	Additional street address information, if required.
Address.City	api_schema_field	City	SP-API Orders Address.City (string)	The city.
Address.County	api_schema_field	County	SP-API Orders Address.County (string)	The county.
Address.District	api_schema_field	District	SP-API Orders Address.District (string)	The district.
Address.StateOrRegion	api_schema_field	State Or Region	SP-API Orders Address.StateOrRegion (string)	The state or region.
Address.Municipality	api_schema_field	Municipality	SP-API Orders Address.Municipality (string)	The municipality.
Address.PostalCode	api_schema_field	Postal Code	SP-API Orders Address.PostalCode (string)	The postal code.
Address.CountryCode	api_schema_field	Country Code	SP-API Orders Address.CountryCode (string)	The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
Address.Phone	pii_not_returned	Phone	SP-API Orders Address.Phone (string)	The phone number of the buyer. Note: 1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed: a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shippe…
Address.ExtendedFields	api_schema_field	Extended Fields	SP-API Orders Address.ExtendedFields (object)	Extended address fields for additional address components including the street name or number. Note: Available for grocery sellers and Brazil shipping addresses.
Address.ExtendedFields.StreetName	pii_not_returned	Street Name	SP-API Orders AddressExtendedFields.StreetName (string)	The street name.
Address.ExtendedFields.StreetNumber	api_schema_field	Street Number	SP-API Orders AddressExtendedFields.StreetNumber (string)	The house, building, or property number associated with the location's street address.
Address.ExtendedFields.Complement	api_schema_field	Complement	SP-API Orders AddressExtendedFields.Complement (string)	The floor number/unit number in the building/private house number.
Address.ExtendedFields.Neighborhood	api_schema_field	Neighborhood	SP-API Orders AddressExtendedFields.Neighborhood (string)	The neighborhood. This value is only used in some countries (such as Brazil).
Address.ExtendedFields.GeoCoordinates	api_schema_field	Geo Coordinates	SP-API Orders AddressExtendedFields.GeoCoordinates (object)	Latitude and longitude coordinates for the shipping address using the WGS84 coordinate system. Note: Available for sellers that support geographic coordinates.
Address.ExtendedFields.GeoCoordinates.Latitude	api_schema_field	Latitude	SP-API Orders GeoCoordinates.Latitude (number)	The latitude coordinate of the shipping address using the WGS84 coordinate system.
Address.ExtendedFields.GeoCoordinates.Longitude	api_schema_field	Longitude	SP-API Orders GeoCoordinates.Longitude (number)	The longitude coordinate of the shipping address using the WGS84 coordinate system.
Address.AddressType	api_schema_field	Address Type	SP-API Orders Address.AddressType (string)	The address type of the shipping address.
BuyerInfo.BuyerEmail	pii_not_returned	Buyer Email	SP-API Orders BuyerInfo.BuyerEmail (string)	The anonymized email address of the buyer.
BuyerInfo.BuyerName	pii_not_returned	Buyer Name	SP-API Orders BuyerInfo.BuyerName (string)	The buyer name or the recipient name.
BuyerInfo.BuyerCounty	pii_not_returned	Buyer County	SP-API Orders BuyerInfo.BuyerCounty (string)	The county of the buyer. Note: This attribute is only available in the Brazil marketplace.
BuyerInfo.BuyerTaxInfo	pii_not_returned	Buyer Tax Info	SP-API Orders BuyerInfo.BuyerTaxInfo (object)	Tax information about the buyer. Sellers could use this data to issue electronic invoices for business orders. Note: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces.
BuyerInfo.BuyerTaxInfo.CompanyLegalName	pii_not_returned	Company Legal Name	SP-API Orders BuyerTaxInfo.CompanyLegalName (string)	The legal name of the company.
BuyerInfo.BuyerTaxInfo.TaxingRegion	pii_not_returned	Taxing Region	SP-API Orders BuyerTaxInfo.TaxingRegion (string)	The country or region imposing the tax.
BuyerInfo.BuyerTaxInfo.TaxClassifications	pii_not_returned	Tax Classifications	SP-API Orders BuyerTaxInfo.TaxClassifications (array)	A list of tax classifications that apply to the order.
BuyerInfo.BuyerTaxInfo.TaxClassifications.Name	pii_not_returned	Name	SP-API Orders TaxClassification.Name (string)	The type of tax.
BuyerInfo.BuyerTaxInfo.TaxClassifications.Value	pii_not_returned	Value	SP-API Orders TaxClassification.Value (string)	The buyer's tax identifier.
BuyerInfo.PurchaseOrderNumber	api_schema_field	Purchase Order Number	SP-API Orders BuyerInfo.PurchaseOrderNumber (string)	The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
BuyerTaxInfo.CompanyLegalName	pii_not_returned	Company Legal Name	SP-API Orders BuyerTaxInfo.CompanyLegalName (string)	The legal name of the company.
BuyerTaxInfo.TaxingRegion	pii_not_returned	Taxing Region	SP-API Orders BuyerTaxInfo.TaxingRegion (string)	The country or region imposing the tax.
BuyerTaxInfo.TaxClassifications	pii_not_returned	Tax Classifications	SP-API Orders BuyerTaxInfo.TaxClassifications (array)	A list of tax classifications that apply to the order.
BuyerTaxInfo.TaxClassifications.Name	pii_not_returned	Name	SP-API Orders TaxClassification.Name (string)	The type of tax.
BuyerTaxInfo.TaxClassifications.Value	pii_not_returned	Value	SP-API Orders TaxClassification.Value (string)	The buyer's tax identifier.
ProductInfoDetail.NumberOfItems	api_schema_field	Number Of Items	SP-API Orders ProductInfoDetail.NumberOfItems (string)	The total number of items that are included in the ASIN.
PaymentExecutionDetailItem.Payment	api_schema_field	Payment	SP-API Orders PaymentExecutionDetailItem.Payment (object)	PaymentExecutionDetailItem.Payment
PaymentExecutionDetailItem.Payment.CurrencyCode	api_schema_field	Currency Code	SP-API Orders Money.CurrencyCode (string)	The three-digit currency code. In ISO 4217 format.
PaymentExecutionDetailItem.Payment.Amount	api_schema_field	Amount	SP-API Orders Money.Amount (string)	The currency amount.
PaymentExecutionDetailItem.PaymentMethod	api_schema_field	Payment Method	SP-API Orders PaymentExecutionDetailItem.PaymentMethod (string)	The sub-payment method for an order. Possible values: * `COD`: Cash on delivery * `GC`: Gift card * `PointsAccount`: Amazon Points * `Invoice`: Invoice * `CreditCard`: Credit card * `Pix`: Pix * `Other`: Other.
PaymentExecutionDetailItem.AcquirerId	api_schema_field	Acquirer Id	SP-API Orders PaymentExecutionDetailItem.AcquirerId (string)	The Brazilian Taxpayer Identifier (CNPJ) of the payment processor or acquiring bank that authorizes the payment. Note: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod` is `CreditCard` or `Pix`.
PaymentExecutionDetailItem.CardBrand	api_schema_field	Card Brand	SP-API Orders PaymentExecutionDetailItem.CardBrand (string)	The card network or brand used in the payment transaction (for example, Visa or Mastercard). Note: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod` is `CreditCard`.
PaymentExecutionDetailItem.AuthorizationCode	api_schema_field	Authorization Code	SP-API Orders PaymentExecutionDetailItem.AuthorizationCode (string)	The unique code that confirms the payment authorization. Note: This attribute is only available for orders in the Brazil (BR) marketplace when the `PaymentMethod` is `CreditCard` or `Pix`.
MarketplaceTaxInfo.TaxClassifications	pii_not_returned	Tax Classifications	SP-API Orders MarketplaceTaxInfo.TaxClassifications (array)	A list of tax classifications that apply to the order.
MarketplaceTaxInfo.TaxClassifications.Name	pii_not_returned	Name	SP-API Orders TaxClassification.Name (string)	The type of tax.
MarketplaceTaxInfo.TaxClassifications.Value	pii_not_returned	Value	SP-API Orders TaxClassification.Value (string)	The buyer's tax identifier.
VerificationDetails.prescriptionDetail	api_schema_field	Prescription Detail	SP-API Orders VerificationDetails.prescriptionDetail (object)	Information regarding the prescription tied to the order.
VerificationDetails.prescriptionDetail.prescriptionId	api_schema_field	Prescription Id	SP-API Orders PrescriptionDetail.prescriptionId (string)	The identifier for the prescription used to verify the regulated product.
VerificationDetails.prescriptionDetail.expirationDate	api_schema_field	Expiration Date	SP-API Orders PrescriptionDetail.expirationDate (string)	The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
VerificationDetails.prescriptionDetail.writtenQuantity	api_schema_field	Written Quantity	SP-API Orders PrescriptionDetail.writtenQuantity (integer)	The number of units in each fill as provided in the prescription.
VerificationDetails.prescriptionDetail.totalRefillsAuthorized	api_schema_field	Total Refills Authorized	SP-API Orders PrescriptionDetail.totalRefillsAuthorized (integer)	The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0.
VerificationDetails.prescriptionDetail.refillsRemaining	api_schema_field	Refills Remaining	SP-API Orders PrescriptionDetail.refillsRemaining (integer)	The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescript…
VerificationDetails.prescriptionDetail.clinicId	api_schema_field	Clinic Id	SP-API Orders PrescriptionDetail.clinicId (string)	The identifier for the clinic which provided the prescription used to verify the regulated product.
VerificationDetails.prescriptionDetail.usageInstructions	api_schema_field	Usage Instructions	SP-API Orders PrescriptionDetail.usageInstructions (string)	The instructions for the prescription as provided by the approver of the regulated product.
VerificationDetails.approvedAlternativeDetails	api_schema_field	Approved Alternative Details	SP-API Orders VerificationDetails.approvedAlternativeDetails (object)	Pre-approved alternative product attributes provided when a vet rejects an order but suggests a correction. Only valid when the verification status is `Rejected`.
VerificationDetails.interimStatusDetail	api_schema_field	Interim Status Detail	SP-API Orders VerificationDetails.interimStatusDetail (object)	Interim status information provided during the verification process. Only valid when the verification status is `Pending`.
VerificationDetails.interimStatusDetail.statusCode	api_schema_field	Status Code	SP-API Orders InterimStatusDetail.statusCode (string)	The identifier for the interim status type. Must be one of the `ValidInterimStatusCodes` values returned by the `getOrderRegulatedInfo` operation.
VerificationDetails.interimStatusDetail.statusDateTime	api_schema_field	Status Date Time	SP-API Orders InterimStatusDetail.statusDateTime (string)	The date and time when this interim status was set, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date and time format.
AutomatedShippingSettings.HasAutomatedShippingSettings	api_schema_field	Has Automated Shipping Settings	SP-API Orders AutomatedShippingSettings.HasAutomatedShippingSettings (boolean)	When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
AutomatedShippingSettings.AutomatedCarrier	api_schema_field	Automated Carrier	SP-API Orders AutomatedShippingSettings.AutomatedCarrier (string)	Auto-generated carrier for SSA orders.
AutomatedShippingSettings.AutomatedShipMethod	api_schema_field	Automated Ship Method	SP-API Orders AutomatedShippingSettings.AutomatedShipMethod (string)	Auto-generated ship method for SSA orders.
OrderRegulatedInfo.AmazonOrderId	api_schema_field	Amazon Order Id	SP-API Orders OrderRegulatedInfo.AmazonOrderId (string)	An Amazon-defined order identifier, in 3-7-7 format.
OrderRegulatedInfo.RegulatedInformation	api_schema_field	Regulated Information	SP-API Orders OrderRegulatedInfo.RegulatedInformation (object)	The regulated information collected during purchase and used to verify the order.
OrderRegulatedInfo.RegulatedInformation.Fields	api_schema_field	Fields	SP-API Orders RegulatedInformation.Fields (array)	A list of regulated information fields as collected from the regulatory form.
OrderRegulatedInfo.RegulatedInformation.Fields.FieldId	api_schema_field	Field Id	SP-API Orders RegulatedInformationField.FieldId (string)	The unique identifier of the field.
OrderRegulatedInfo.RegulatedInformation.Fields.FieldLabel	api_schema_field	Field Label	SP-API Orders RegulatedInformationField.FieldLabel (string)	The name of the field.
OrderRegulatedInfo.RegulatedInformation.Fields.FieldType	api_schema_field	Field Type	SP-API Orders RegulatedInformationField.FieldType (string)	The type of field.
OrderRegulatedInfo.RegulatedInformation.Fields.FieldValue	api_schema_field	Field Value	SP-API Orders RegulatedInformationField.FieldValue (string)	The content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment.
OrderRegulatedInfo.RequiresDosageLabel	api_schema_field	Requires Dosage Label	SP-API Orders OrderRegulatedInfo.RequiresDosageLabel (boolean)	When true, the order requires attaching a dosage information label when shipped.
OrderRegulatedInfo.RegulatedOrderVerificationStatus	api_schema_field	Regulated Order Verification Status	SP-API Orders OrderRegulatedInfo.RegulatedOrderVerificationStatus (object)	The order's verification status.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.Status	api_schema_field	Status	SP-API Orders RegulatedOrderVerificationStatus.Status (object)	The verification status of the order.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.RequiresMerchantAction	api_schema_field	Requires Merchant Action	SP-API Orders RegulatedOrderVerificationStatus.RequiresMerchantAction (boolean)	When true, the regulated information provided in the order requires a review by the merchant.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidRejectionReasons	api_schema_field	Valid Rejection Reasons	SP-API Orders RegulatedOrderVerificationStatus.ValidRejectionReasons (array)	A list of valid rejection reasons that may be used to reject the order's regulated information.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidRejectionReasons.RejectionReasonId	api_schema_field	Rejection Reason Id	SP-API Orders RejectionReason.RejectionReasonId (string)	The unique identifier for the rejection reason.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidRejectionReasons.RejectionReasonDescription	api_schema_field	Rejection Reason Description	SP-API Orders RejectionReason.RejectionReasonDescription (string)	The description of this rejection reason.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.RejectionReason	api_schema_field	Rejection Reason	SP-API Orders RegulatedOrderVerificationStatus.RejectionReason (object)	The reason for rejecting the order's regulated information. Not present if the order isn't rejected.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.RejectionReason.RejectionReasonId	api_schema_field	Rejection Reason Id	SP-API Orders RejectionReason.RejectionReasonId (string)	The unique identifier for the rejection reason.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.RejectionReason.RejectionReasonDescription	api_schema_field	Rejection Reason Description	SP-API Orders RejectionReason.RejectionReasonDescription (string)	The description of this rejection reason.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ReviewDate	api_schema_field	Review Date	SP-API Orders RegulatedOrderVerificationStatus.ReviewDate (string)	The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ExternalReviewerId	api_schema_field	External Reviewer Id	SP-API Orders RegulatedOrderVerificationStatus.ExternalReviewerId (string)	The identifier for the order's regulated information reviewer.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidVerificationDetails	api_schema_field	Valid Verification Details	SP-API Orders RegulatedOrderVerificationStatus.ValidVerificationDetails (array)	A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidVerificationDetails.VerificationDetailType	api_schema_field	Verification Detail Type	SP-API Orders ValidVerificationDetail.VerificationDetailType (string)	A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid values: `prescriptionDetail`, `approvedAlternativeDetails`, `interimStatusDetail`.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidVerificationDetails.ValidVerificationStatuses	api_schema_field	Valid Verification Statuses	SP-API Orders ValidVerificationDetail.ValidVerificationStatuses (array)	A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is ["Approved"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus`…
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidInterimStatusCodes	api_schema_field	Valid Interim Status Codes	SP-API Orders RegulatedOrderVerificationStatus.ValidInterimStatusCodes (array)	Valid interim status codes that may be used when populating `InterimStatusDetail`. Each element contains a `StatusCode` identifier and its customer-facing `StatusDescription`.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidInterimStatusCodes.StatusCode	api_schema_field	Status Code	SP-API Orders ValidInterimStatusCode.StatusCode (string)	The identifier for the interim status type.
OrderRegulatedInfo.RegulatedOrderVerificationStatus.ValidInterimStatusCodes.StatusDescription	api_schema_field	Status Description	SP-API Orders ValidInterimStatusCode.StatusDescription (string)	A customer-facing description of the interim status.

フューチャーショップ

EC / API key

準備中

フューチャーショップの売上サマリーと注文一覧を読み取ります。

MCPツール

ツール	引数	戻り値	説明
futureshop_sales_summary	start_date, end_date	sales / orders	フューチャーショップの売上サマリーを取得する
futureshop_recent_orders	limit	orders	フューチャーショップの直近注文を取得する

フィールド

ID	型	表示名	媒体側API名	説明
orderDateStart	official_response_field	受注日時(from)	futureshop 受注検索API response	受注日時(from)
orderDateEnd	official_response_field	受注日時(to)	futureshop 受注検索API response	受注日時(to)
shippingStatus	official_response_field	発送ステータス	futureshop 受注検索API response	発送ステータス
paymentStatus	official_response_field	入金ステータス	futureshop 受注検索API response	入金ステータス
cancelDateStart	official_response_field	受注キャンセル日時(from)	futureshop 受注検索API response	受注キャンセル日時(from)
cancelDateEnd	official_response_field	受注キャンセル日時(to)	futureshop 受注検索API response	受注キャンセル日時(to)
updateDateStart	official_response_field	最終更新日時(from)	futureshop 受注検索API response	・更新対象の項目や更新方法によっては、最終更新日時が更新されない場合がございます。連携開発に関わる場合は、お問い合わせください。・最終更新日時(from)から最終更新日時(to)で指定可能な最大日数は、31日までです。
updateDateEnd	official_response_field	最終更新日時(to)	futureshop 受注検索API response	・更新対象の項目や更新方法によっては、最終更新日時が更新されない場合がございます。連携開発に関わる場合は、お問い合わせください。・最終更新日時(from)から最終更新日時(to)で指定可能な最大日数は、31日までです。
cancelRequestDateStart	official_response_field	受注キャンセルリクエスト日時(from)	futureshop 受注検索API response	受注キャンセルリクエスト日時(from)
cancelRequestDateEnd	official_response_field	受注キャンセルリクエスト日時(to)	futureshop 受注検索API response	受注キャンセルリクエスト日時(to)
cursor	official_response_field	カーソル	futureshop 受注検索API response	カーソル
nextUrl	official_response_field	ネクストURL	futureshop 受注検索API response	100件を超過する結果の場合、次のデータ取得のURLを返却（※）
orderList	official_response_field	受注リスト	futureshop 受注検索API response	受注ごとに配列出力。最大100件
HOKKAIDO	official_response_field	北海道	futureshop 受注検索API response	岩手県
MIYAGI	official_response_field	宮城県	futureshop 受注検索API response	茨城県
TOCHIGI	official_response_field	栃木県	futureshop 受注検索API response	千葉県
KANAGAWA	official_response_field	神奈川県	futureshop 受注検索API response	新潟県
NAGANO	official_response_field	長野県	futureshop 受注検索API response	三重県
GIFU	official_response_field	岐阜県	futureshop 受注検索API response	福井県
OSAKA	official_response_field	大阪府	futureshop 受注検索API response	奈良県
WAKAYAMA	official_response_field	和歌山県	futureshop 受注検索API response	広島県
YAMAGUCHI	official_response_field	山口県	futureshop 受注検索API response	香川県
TOKUSHIMA	official_response_field	徳島県	futureshop 受注検索API response	福岡県
SAGA	official_response_field	佐賀県	futureshop 受注検索API response	大分県
MIYAZAKI	official_response_field	宮崎県	futureshop 受注検索API response	その他
status	official_response_field	ステータス	futureshop 受注検索API response	ステータス
errors	official_response_field	エラーリスト	futureshop 受注検索API response	エラー時のみ出力
No	official_response_field	code	futureshop 受注検索API response	HTTPコード
orderNo	official_response_field	受注番号	futureshop 受注取得API response	受注番号
date	official_response_field	注文日時	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
grandTotal	official_response_field	請求合計金額	futureshop 受注取得API response	総合計金額 - ポイント利用額 - 値引合計金額（商品）- 値引合計金額（送料） - 割引額 - バンドル販売割引金額
totalCost	official_response_field	総合計金額	futureshop 受注取得API response	値引き前の金額（商品合計金額＋包装手数料＋送料＋決済手数料＋クール便手数料）
productTotal	official_response_field	商品合計金額	futureshop 受注取得API response	税込み商品本体＋オプション価格
taxTotal	official_response_field	消費税合計	futureshop 受注取得API response	内税設定している場合は、「0」と出力（消費税のみの金額データは取得できません）商品・オプション価格の税額（手数料・送料の消費税は除く）
giftWrappingChargeTotal	official_response_field	包装手数料	futureshop 受注取得API response	包装手数料
postage	official_response_field	送料	futureshop 受注取得API response	送料
paymentChargeTotal	official_response_field	決済手数料	futureshop 受注取得API response	決済手数料
coolDeliveryChargeTotal	official_response_field	クール便手数料	futureshop 受注取得API response	クール便手数料
paymentType	official_response_field	決済方法	futureshop 受注取得API response	BANK_TRANSFER：銀行振込 COD：代金引換 POSTAL_TRANSFER：郵便振込 FREGI_CONVENI：コンビニ支払（F-REGI） FREGI_CREDIT_CARD：クレジットカード（F-REGI） IN_STORE：店頭払い RAKUTEN_BANK：楽天銀行（リアルタイム自動引落） ORICO_WEB_CREDIT：オリコWebクレジット NONE：決済不要 NP_POSTPAY：NP後払い（CSV） AMAZON_PAY：Amazon Pay RAKUTEN_PAY：楽天ペイ（オン…
conveniType	official_response_field	コンビニ区分	futureshop 受注取得API response	SEVEN_ELEVEN：セブンイレブン LAWSON：ローソン FAMILY_MART：ファミリーマート SEICO_MART：セイコーマート MINISTOP：ミニストップ
conveniPayoutNo	official_response_field	コンビニ支払番号	futureshop 受注取得API response	コンビニ支払番号
deviceType	official_response_field	購入経路区分	futureshop 受注取得API response	PC MOBILE SMART_PHONE
communication	official_response_field	通信欄	futureshop 受注取得API response	通信欄
customerContact	official_response_field	お客様へのご連絡事項	futureshop 受注取得API response	お客様へのご連絡事項
shopMemo	official_response_field	ショップメモ	futureshop 受注取得API response	ショップメモ
cancelDate	official_response_field	キャンセル日時	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
cancelRequestDate	official_response_field	キャンセルリクエスト日時	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
cancelRequestRevoked	official_response_field	キャンセルリクエスト取消	futureshop 受注取得API response	true：キャンセルリクエスト取消 false：上記以外
receiptDate	official_response_field	入金確認日	futureshop 受注取得API response	「yyyy-mm-dd」形式
receiptShopName	pii_not_returned	支払い店舗	futureshop 受注取得API response	決済方法がIN_STORE：店頭払いの場合に出力
orderEmailDateSent	pii_not_returned	メール送信日（注文確認）	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
paymentEmailNumSent	pii_not_returned	メール送信回数（入金確認）	futureshop 受注取得API response	メール送信回数（入金確認）
paymentEmailDateSent	pii_not_returned	メール送信日（入金確認）	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
oricoProcedureDate	official_response_field	オリコWebクレジット手続き日	futureshop 受注取得API response	「yyyy-mm-dd」形式
multipleShipments	official_response_field	複数お届け先フラグ	futureshop 受注取得API response	true：複数お届け先 false：1お届け先
usedPoint	official_response_field	利用ポイント数	futureshop 受注取得API response	利用ポイント数を出力
usedPointPrice	official_response_field	ポイント利用額	futureshop 受注取得API response	ポイント利用による金額（ポイント×換金率）を出力
earnedPointStatus	official_response_field	ポイントステータス	futureshop 受注取得API response	UNDEFINED：未設定 INVALID：無効 SUSPENDED：保留 EXPIRED：期限切れ USED：利用済 VALID：有効 PENDING：有効待ち
dateLastUpdated	pii_not_returned	最終更新日	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
fregiOrderNo	official_response_field	F-REGI取引番号	futureshop 受注取得API response	F-REGI取引番号
fregiAuthNo	official_response_field	F-REGI承認番号	futureshop 受注取得API response	F-REGI承認番号
thanksEmailNumSent	pii_not_returned	メール送信回数（サンクス）	futureshop 受注取得API response	メール送信回数（サンクス）
thanksEmailDateSent	pii_not_returned	メール送信日（サンクス）	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
type	official_response_field	受注種別	futureshop 受注取得API response	REGULAR：通常受注 SUBSCRIPTION：定期受注 HANPUKAI：頒布会受注 PREORDER：予約受注
productCouponDiscountName	pii_not_returned	割引名（商品）	futureshop 受注取得API response	クーポン名
productCouponDiscountTotal	official_response_field	割引合計金額（商品）	futureshop 受注取得API response	クーポン割引額
postageCouponDiscountName	pii_not_returned	割引名（送料）	futureshop 受注取得API response	クーポン名
postageCouponDiscountTotal	official_response_field	割引合計金額（送料）	futureshop 受注取得API response	クーポン割引額
couponName	pii_not_returned	利用クーポン	futureshop 受注取得API response	利用クーポン
couponList	official_response_field	利用クーポンリスト	futureshop 受注取得API response	利用クーポンリスト
volumeDiscountName	pii_not_returned	割引名	futureshop 受注取得API response	割引名
volumeDiscountTotal	official_response_field	割引合計金額	futureshop 受注取得API response	設定＞割引＞購入金額別割引設定／【CC未利用・移行中】構築＞送料・決済設定＞割引設定による割引合計金額ポイント、クーポンやバンドル値引き額は含まれません。
blackOrder	official_response_field	ブラック警告	futureshop 受注取得API response	true：ブラック false：非ブラック
dateProcessed	official_response_field	注文処理日	futureshop 受注取得API response	「yyyy-mm-ddThh:mm:ss」形式
bundleDiscountCaption	official_response_field	バンドル販売割引金額キャプション	futureshop 受注取得API response	バンドル販売割引金額キャプション
bundleDiscountTotal	official_response_field	バンドル販売割引金額	futureshop 受注取得API response	バンドル販売割引金額
bundleUrls	official_response_field	適用バンドル販売URL情報	futureshop 受注取得API response	適用バンドル販売URL情報
bundleNames	pii_not_returned	適用バンドル販売名情報	futureshop 受注取得API response	適用バンドル販売名情報
amazonOrderReferenceId	official_response_field	AmazonリファレンスID	futureshop 受注取得API response	※定期・頒布会受注の場合は「空文字」を出力
rakutenPayOrderId	official_response_field	楽天ペイ（オンライン決済）番号	futureshop 受注取得API response	楽天ペイ（オンライン決済）番号
subscriptionNo	official_response_field	申込コード	futureshop 受注取得API response	申込コード
subscriptionPeriodNo	official_response_field	受注確定回（定期・頒布会）	futureshop 受注取得API response	受注確定回（定期・頒布会）
subscriptionTotalNumPeriods	official_response_field	処理済み受注回数（定期・頒布会	futureshop 受注取得API response	処理済み受注回数（定期・頒布会
taxConfigEnabled	official_response_field	消費税加算フラグ	futureshop 受注取得API response	true：税込 false：税別
taxRoundingType	official_response_field	消費税端数計算区分	futureshop 受注取得API response	ROUND_DOWN：切り捨て ROUND_HALF_UP：四捨五入 ROUND_UP：切り上げ
standardTaxRate	official_response_field	標準税率	futureshop 受注取得API response	標準税率
reducedTaxRate	official_response_field	軽減税率	futureshop 受注取得API response	軽減税率
rateDiscountTargetPriceStdTaxIncl	official_response_field	[按分値引き]対象金額（標準税率）	futureshop 受注取得API response	[按分値引き]対象金額（標準税率）
rateDiscountTargetPriceReducedTaxIncl	official_response_field	[按分値引き]対象金額（軽減税率）	futureshop 受注取得API response	[按分値引き]対象金額（軽減税率）
rateDiscountTargetPriceStdTax	official_response_field	[按分値引き]内消費税等（標準税率）	futureshop 受注取得API response	[按分値引き]内消費税等（標準税率）
rateDiscountTargetPriceReducedTax	official_response_field	[按分値引き]内消費税等（軽減税率）	futureshop 受注取得API response	[按分値引き]内消費税等（軽減税率）
priorityDiscountTargetPriceStdTaxIncl	official_response_field	[標準税率優先値引き]対象金額（標準税率）	futureshop 受注取得API response	[標準税率優先値引き]対象金額（標準税率）
priorityDiscountTargetPriceReducedTaxIncl	official_response_field	[標準税率優先値引き]対象金額（軽減税率）	futureshop 受注取得API response	[標準税率優先値引き]対象金額（軽減税率）
priorityDiscountTargetPriceStdTax	official_response_field	[標準税率優先値引き]内消費税等（標準税率）	futureshop 受注取得API response	[標準税率優先値引き]内消費税等（標準税率）
priorityDiscountTargetPriceReducedTax	official_response_field	[標準税率優先値引き]内消費税等（軽減税率）	futureshop 受注取得API response	[標準税率優先値引き]内消費税等（軽減税率）
sbpsTrackingId	official_response_field	SBPS処理トラッキングID	futureshop 受注取得API response	SBPS利用店舗のみ
sbpsFraudScoringId	official_response_field	SBPS不正スコアリングID	futureshop 受注取得API response	SBPS利用店舗のみ AI不正検知対象のクレジッカードを利用した受注について、SBPSに問合せをする際に必要なID「不正スコアリングID」を出力 ※詳しくは AI不正検知についてをご覧ください。
sbpsAlert	official_response_field	SBPSアラート	futureshop 受注取得API response	SBPS利用店舗のみ WARN：警告 ※詳しくは AI不正検知についてをご覧ください。
npTransactionId	official_response_field	NP後払い取引ID	futureshop 受注取得API response	NP後払い（即時与信）で決済された場合に、NP取引IDを出力
paidyPaymentId	official_response_field	PaidyペイメントID	futureshop 受注取得API response	あと払い（ペイディ）で決済された場合に、Payment IDを出力
campaignPostage	official_response_field	キャンペーン設定（送料）	futureshop 受注取得API response	キャンペーン設定（送料）
campaignPointRate	official_response_field	キャンペーン設定（ポイント付与率）	futureshop 受注取得API response	整数2桁・小数点以下1桁
ipAddress	pii_not_returned	IPアドレス	futureshop 受注取得API response	IPアドレス
buyerInfo	official_response_field	購入者情報	futureshop 受注取得API response	購入者情報
limit	request_or_pagination_field	取得件数	futureshop 受注検索API request	1回あたりの取得件数です。

YouTube

SNS・コンテンツ / Google OAuth

提供中

チャンネル、再生数、視聴時間、登録者、上位動画を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_youtube_channels	なし	channel_id / title	接続済みYouTubeチャンネルを一覧化する
youtube_channel_summary	start_date, end_date, channel_id	views / watch_time / subscribers	チャンネル指標の日次推移を取得する
youtube_top_videos	start_date, end_date, channel_id	videos	上位動画を取得する

フィールド

ID	型	表示名	媒体側API名	説明
video	official_dimension	video (core dimension)	video	The ID of a YouTube video. In the YouTube Data API, this is the value of a video resource's id property. This is a core dimension and is subject to the Deprecation Policy .
playlist	official_dimension	playlist	playlist	The ID of a YouTube playlist. In the YouTube Data API, this is the value of a playlist resource's id property.
channel	official_dimension	channel (core dimension) (only used in content owner reports)	channel	The ID for a YouTube channel. In the YouTube Data API, this is the value of a channel resource's id property. This is a core dimension and is subject to the Deprecation Policy . The channel dimension is frequently used in content owner reports because those r…
group	official_dimension	group (filter only)	group	The ID of a YouTube Analytics group. You can retrieve this value using the YouTube Analytics API's groups.list method. When you use the group filter, the API response contains data for all of the videos, playlists, or channels in that group.
country	official_dimension	country (core dimension)	country	The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US , CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated…
province	official_dimension	province	province	The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report…
dma	official_dimension	dma	dma	The 3-digit identifier that Nielsen uses to identify the Designated Market Area (DMA) associated with the viewing events described in the data row.
city	official_dimension	city	city	The estimated city associated with the metrics in the report row. Data for this dimension is available for dates beginning January 1, 2022.
continent	official_dimension	continent (filter only)	continent	A United Nations (UN) statistical region code. The API supports the following values: Values 002 Africa 019 Americas (Northern America, Latin America, South America, and the Caribbean) 142 Asia 150 Europe 009 Oceania This dimension can only be used to filter…
subContinent	official_dimension	subContinent (filter only)	subContinent	A UN statistical region code that identifies a geographical sub-region. The United Nations Statistics Division lists sub-regions as well as the countries it associates with each region. Display the list of supported sub-regions. Value Region Sub-region 014 Af…
day	official_dimension	day (core dimension)	day	When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. You can use other dimensions to break down the data even further. For example, a traffic source report can aggregate daily viewing statistic…
month	official_dimension	month (core dimension)	month	Data in the report is aggregated by calendar month. As with daily reports, you can use other filters to segment the data even further. In the report, dates are listed in YYYY-MM format. Note: If your API query uses the month dimension, then the start-date and…
insightPlaybackLocationType	official_dimension	insightPlaybackLocationType	insightPlaybackLocationType	Data in the report is aggregated based on the type of page or application where video playbacks occurred. Possible values for this dimension are: BROWSE – The data describes views that took place on the YouTube home page or home screen, in the user's subscrip…
insightPlaybackLocationDetail	official_dimension	insightPlaybackLocationDetail	insightPlaybackLocationDetail	Data is aggregated based on the page where the player is located. Note that this report is only supported for views that occurred in embedded players, and it identifies the embedded players that generated the most views for a specified video. Thus, it provide…
creatorContentType	official_dimension	creatorContentType	creatorContentType	This dimension identifies the type of content associated with the user activity metrics in the data row. Data for this dimension is available for dates beginning January 1, 2019. The following table lists dimension values: Values LIVE_STREAM The viewed conten…
liveOrOnDemand	official_dimension	liveOrOnDemand	liveOrOnDemand	This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The following table lists dimension values: Values LIVE The row's…
subscribedStatus	official_dimension	subscribedStatus	subscribedStatus	This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video's or playlist's channel. Possible values are SUBSCRIBED and UNSUBSCRIBED . Note that the dimension value is accurate as of…
youtubeProduct	official_dimension	youtubeProduct	youtubeProduct	This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The following table lists dimension values: Values CORE The user activity that did not occur in one of the specialty Y…
insightTrafficSourceType	official_dimension	insightTrafficSourceType	insightTrafficSourceType	Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. Possible values for this dimension are: ADVERTISING – The viewer was referred to the video by an advertisement. If you filter based on th…
insightTrafficSourceDetail	official_dimension	insightTrafficSourceDetail	insightTrafficSourceDetail	Data in the report is aggregated based on the referrers that generated the most views for a specified video and a specified traffic source type. The following list identifies the traffic sources for which this report is available. For each traffic source, the…
deviceType	official_dimension	deviceType	deviceType	This dimension identifies the physical form factor of the device on which the view occurred. The following list identifies the device types for which the API returns data. You can also use the deviceType dimension as a filter to restrict an operating system r…
operatingSystem	official_dimension	operatingSystem	operatingSystem	This dimension identifies the software system of the device on which the view occurred. The following list identifies the operating systems for which the API returns data. You can also use the operatingSystem as a filter to restrict a device type report to on…
ageGroup	official_dimension	ageGroup (core dimension)	ageGroup	This dimension identifies the age group of the logged-in users associated with the report data, and includes users that YouTube estimates to be under 18 years old. The API uses the following age groups: age13-17 age18-24 age25-34 age35-44 age45-54 age55-64 ag…
gender	official_dimension	gender (core dimension)	gender	This dimension identifies the gender of the logged-in users associated with the report data. Valid values are female , male and user_specified . This is a core dimension and is subject to the Deprecation Policy .
sharingService	official_dimension	sharingService (core dimension)	sharingService	This dimension identifies the service that was used to share videos. Videos can be shared on YouTube (or via the YouTube player) using the "Share" button. This is a core dimension and is subject to the Deprecation Policy . The following table lists valid dime…
elapsedVideoTimeRatio	official_dimension	elapsedVideoTimeRatio	elapsedVideoTimeRatio	This dimension specifies the ratio of the elapsed portion of the video to the video's length. Retention dimensions and metrics are used to measure audience retention over time, and the elapsedVideoTimeRatio dimension is the time measurement. For example, a va…
audienceType	official_dimension	audienceType (filter only)	audienceType	The dimension value identifies the type of traffic associated with the report data. Supported values are ORGANIC , AD_INSTREAM , and AD_INDISPLAY . See the YouTube Help Center for explanations of these traffic source types. Note that data for the audienceType…
livestreamPosition	official_dimension	livestreamPosition	livestreamPosition	This dimension specifies a particular minute during a live video stream. The report metrics indicate how many users were watching the livestream at that time.
membershipsCancellationSurveyReason	official_dimension	membershipsCancellationSurveyReason	membershipsCancellationSurveyReason	The number of surveys completed by YouTube users who canceled their channel membership for the specified channel during the reporting period. The following table lists valid dimension values: API value Explanation UNKNOWN The user did not complete the survey.…
engagedViews	official_metric	engagedViews (core metric)	engagedViews	The number of times the channel's videos have been viewed past the initial seconds.
views	official_metric	views (core metric)	views	This metric represents different numbers in different types of reports. This is a core metric and is subject to the Deprecation Policy .
playlistViews	official_metric	playlistViews	playlistViews	This metric is defined in the playlist metrics section.
redViews	official_metric	redViews	redViews	The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
viewerPercentage	official_metric	viewerPercentage (core metric)	viewerPercentage	The percentage of viewers who were logged in when watching the video or playlist. This is a core metric and is subject to the Deprecation Policy .
estimatedMinutesWatched	official_metric	estimatedMinutesWatched (core metric)	estimatedMinutesWatched	The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. This is a core metric and is subject to the Deprecation Policy .
estimatedRedMinutesWatched	official_metric	estimatedRedMinutesWatched	estimatedRedMinutesWatched	The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
averageViewDuration	official_metric	averageViewDuration (core metric)	averageViewDuration	The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist.…
averageViewPercentage	official_metric	averageViewPercentage	averageViewPercentage	The average percentage of a video watched during a video playback. As of December 13, 2021, this metric excludes looping clips traffic.
comments	official_metric	comments (core metric)	comments	The number of times that users commented on a video. See the YouTube Help Center for more information. This is a core metric and is subject to the Deprecation Policy .
likes	official_metric	likes (core metric)	likes	The number of times that users indicated that they liked a video by giving it a positive rating. This is a core metric and is subject to the Deprecation Policy .
dislikes	official_metric	dislikes (core metric)	dislikes	The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy .
shares	official_metric	shares (core metric)	shares	The number of times that users shared a video through the Share button. See the YouTube Help Center for more information. This is a core metric and is subject to the Deprecation Policy .
subscribersGained	official_metric	subscribersGained (core metric)	subscribersGained	The number of times that users subscribed to a channel. This is a core metric and is subject to the Deprecation Policy . Channels can gain or lose subscribers in several places, including the video watch page, the channel page, and the guide that appears on t…
subscribersLost	official_metric	subscribersLost (core metric)	subscribersLost	The number of times that users unsubscribed from a channel. This is a core metric and is subject to the Deprecation Policy . Data for this metric is reported similarly to the subscribersGained metric. In channel reports, this metric includes subscribers lost…
videosAddedToPlaylists	official_metric	videosAddedToPlaylists	videosAddedToPlaylists	The number of times that videos were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists. The metric value does include the number of times that videos were added to default playlists…
videosRemovedFromPlaylists	official_metric	videosRemovedFromPlaylists	videosRemovedFromPlaylists	The number of times that videos were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists. The metric value includes the number of times that videos were removed from default…
averageTimeInPlaylist	official_metric	averageTimeInPlaylist	averageTimeInPlaylist	The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
playlistAverageViewDuration	official_metric	playlistAverageViewDuration	playlistAverageViewDuration	The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer sp…
playlistEstimatedMinutesWatched	official_metric	playlistEstimatedMinutesWatched	playlistEstimatedMinutesWatched	The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts—for example, watch time from views that occurred when viewers were watching the same video as part of other playlists—is not co…
playlistSaves	official_metric	playlistSaves	playlistSaves	The net number of times that users saved a playlist. See the YouTube Help Center for more information about saved playlists. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and sav…
playlistStarts	official_metric	playlistStarts	playlistStarts	The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
viewsPerPlaylistStart	official_metric	viewsPerPlaylistStart	viewsPerPlaylistStart	The average number of video views that occurred each time a playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
annotationImpressions	official_metric	annotationImpressions	annotationImpressions	The total number of annotation impressions.
annotationClickableImpressions	official_metric	annotationClickableImpressions	annotationClickableImpressions	The number of annotations that appeared and could be clicked.
annotationClicks	official_metric	annotationClicks	annotationClicks	The number of clicked annotations.
annotationClickThroughRate	official_metric	annotationClickThroughRate (core metric)	annotationClickThroughRate	The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. This is a core metric and is subject to the Deprecation Policy . The YouTube Help Center has more information about creating annotations and using link anno…
annotationClosableImpressions	official_metric	annotationClosableImpressions	annotationClosableImpressions	The number of annotations that appeared and could be closed.
annotationCloses	official_metric	annotationCloses	annotationCloses	The number of closed annotations.
annotationCloseRate	official_metric	annotationCloseRate (core metric)	annotationCloseRate	The ratio of annotations that viewers closed to the total number of annotation impressions. This is a core metric and is subject to the Deprecation Policy .
cardImpressions	official_metric	cardImpressions	cardImpressions	The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards.
cardClicks	official_metric	cardClicks	cardClicks	The number of times that cards were clicked.
cardClickRate	official_metric	cardClickRate	cardClickRate	The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
cardTeaserImpressions	official_metric	cardTeaserImpressions	cardTeaserImpressions	The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
cardTeaserClicks	official_metric	cardTeaserClicks	cardTeaserClicks	The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
cardTeaserClickRate	official_metric	cardTeaserClickRate	cardTeaserClickRate	The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions.
averageConcurrentViewers	official_metric	averageConcurrentViewers	averageConcurrentViewers	The average number of concurrent viewers for a particular video. If the livestreamPosition dimension is specified for the report, then the averageConcurrentViewers value specifies the average number of concurrent viewers during a particular segment
peakConcurrentViewers	official_metric	peakConcurrentViewers	peakConcurrentViewers	The peak number of concurrent viewers for a particular video. If the livestreamPosition dimension is specified for the report, then the peakConcurrentViewers value specifies the peak number of concurrent viewers during a particular segment of the video.
audienceWatchRatio	official_metric	audienceWatchRatio	audienceWatchRatio	The absolute ratio of viewers watching the video at the given point in the video. The ratio is calculated by comparing the number of times a portion of a video has been watched to the total number of views of the video. The elapsedVideoTimeRatio dimension ide…
relativeRetentionPerformance	official_metric	relativeRetentionPerformance	relativeRetentionPerformance	A measurement that shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. The metric has a value between 0 and 1 that identifies the video's relative retention performance at a given point in the video.…
startedWatching	official_metric	startedWatching	startedWatching	The number of times a particular segment of the video was the first segment seen during a video playback. For example, suppose Video X is 5 minutes long. For the purposes of this report, YouTube divides the video into 100 3-second segments, which are identifi…
stoppedWatching	official_metric	stoppedWatching	stoppedWatching	The number of times a particular segment of the video was the last segment seen during a video playback. Refer to the definition of the startedWatching metric for an example of how this metric value is calculated.
totalSegmentImpressions	official_metric	totalSegmentImpressions	totalSegmentImpressions	The number of times a particular segment of a video was viewed. Refer to the definition of the startedWatching metric for an example of how this metric value is calculated. Note that a viewer can watch the same segment of a video multiple times in the same pl…
membershipsCancellationSurveyResponses	official_metric	membershipsCancellationSurveyResponses	membershipsCancellationSurveyResponses	The number of surveys completed by YouTube users who canceled their channel membership for the specified channel during the reporting period.
estimatedRevenue	official_metric	estimatedRevenue (core metric) (previously named earnings )	estimatedRevenue	The total estimated net revenue from all Google-sold advertising sources as well as from non-advertising sources for the selected date range and region. This is a core metric and is subject to the Deprecation Policy . Estimated revenue metrics are subject to…
estimatedAdRevenue	official_metric	estimatedAdRevenue (previously named adEarnings )	estimatedAdRevenue	The total estimated net revenue from all Google-sold advertising sources for the selected date range and region. Estimated revenue metrics are subject to month-end adjustment and don't include partner-sold and partner-served advertising.
estimatedRedPartnerRevenue	official_metric	estimatedRedPartnerRevenue (previously named redPartnerRevenue )	estimatedRedPartnerRevenue	The total estimated revenue earned from YouTube Premium (previously known as YouTube Red) subscriptions for the selected report dimensions. The metric's value reflects revenue from both music and non-music content and is subject to month-end adjustment.
grossRevenue	official_metric	grossRevenue	grossRevenue	The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue shouldn't…
cpm	official_metric	cpm (previously named impressionBasedCpm )	cpm	The estimated gross revenue per thousand ad impressions.
adImpressions	official_metric	adImpressions (previously named impressions )	adImpressions	The number of verified ad impressions served.
monetizedPlaybacks	official_metric	monetizedPlaybacks	monetizedPlaybacks	The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this…
playbackBasedCpm	official_metric	playbackBasedCpm	playbackBasedCpm	The estimated gross revenue per thousand playbacks.
channel.id	data_api_field	チャンネルID	YouTube Data API channels.id	接続チャンネルのIDです。
channel.snippet.title	data_api_field	チャンネル名	channels.snippet.title	チャンネルタイトルです。
channel.statistics.subscriberCount	data_api_field	登録者数	channels.statistics.subscriberCount	チャンネル登録者数です。
channel.statistics.videoCount	data_api_field	動画数	channels.statistics.videoCount	公開動画数です。
channel.statistics.viewCount	data_api_field	累計再生数	channels.statistics.viewCount	チャンネル累計再生数です。
video.id	data_api_field	動画ID	videos.id	動画を識別するIDです。
video.snippet.title	data_api_field	動画タイトル	videos.snippet.title	動画タイトルです。

Instagram

SNS・コンテンツ / Meta OAuth

準備中

Instagramアカウントのインサイトと上位メディアを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_instagram_accounts	なし	account_id / username	接続済みInstagramアカウントを一覧化する
instagram_account_insights	start_date, end_date, account_id	reach / impressions / followers	Instagramアカウント指標を取得する
instagram_top_media	start_date, end_date, account_id	media	上位投稿を取得する

フィールド

ID	型	表示名	媒体側API名	説明
impressions	official_metric	表示回数	Instagram User Insights	アカウントまたはメディアの表示回数です。
reach	official_metric	リーチ	Instagram User/Media Insights	到達したアカウント数です。
profile_views	official_metric	プロフィールビュー	Instagram User Insights	プロフィール閲覧数です。
follower_count	official_metric	フォロワー数	Instagram User Insights	フォロワー数です。
online_followers	official_metric	オンラインフォロワー	Instagram User Insights	オンラインだったフォロワー分布です。
accounts_engaged	official_metric	エンゲージしたアカウント	Instagram Insights	コンテンツに反応したアカウント数です。
total_interactions	official_metric	総インタラクション	Instagram Media Insights	投稿への合計インタラクション数です。
likes	official_metric	いいね	Instagram Media Insights	メディアへのいいね数です。
comments	official_metric	コメント	Instagram Media Insights	メディアへのコメント数です。
shares	official_metric	シェア	Instagram Media Insights	メディアのシェア数です。
saved	official_metric	保存	Instagram Media Insights	メディアの保存数です。
views	official_metric	ビュー	Instagram Media Insights	メディアビュー数です。
replies	official_metric	返信	Instagram Media Insights	ストーリー等への返信数です。
ig_reels_avg_watch_time	official_metric	Reels平均視聴時間	Instagram Media Insights	Reelsの平均視聴時間です。
ig_reels_video_view_total_time	official_metric	Reels総視聴時間	Instagram Media Insights	Reelsの総視聴時間です。
profile_links_taps	official_metric	プロフィールリンクタップ	Instagram User Insights	プロフィール上リンクのタップ数です。
id	graph_field	投稿ID	/{ig-user-id}/media fields	InstagramメディアIDです。
caption	graph_field	キャプション	media.caption	投稿キャプションです。
media_type	graph_field	メディア種別	media.media_type	IMAGE/VIDEO/CAROUSEL_ALBUMなどの種別です。
media_url	graph_field	メディアURL	media.media_url	メディアURLです。
permalink	graph_field	投稿URL	media.permalink	Instagram投稿へのURLです。
timestamp	graph_field	投稿日時	media.timestamp	投稿日時です。
like_count	graph_field	いいね数	media.like_count	投稿オブジェクト上のいいね数です。
comments_count	graph_field	コメント数	media.comments_count	投稿オブジェクト上のコメント数です。
username	graph_field	ユーザー名	instagram_business_account.username	Instagramビジネスアカウントのユーザー名です。
media_count	graph_field	投稿数	instagram_business_account.media_count	アカウントの投稿数です。

LINE公式アカウント

SNS・コンテンツ / Channel access token

提供中

友だち数、属性、メッセージ配信のインタラクションを読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_line_accounts	なし	account_id / name	接続済みLINE公式アカウントを一覧化する
line_account_summary	start_date, end_date	followers / messages	友だち数などのサマリーを取得する
line_friend_demographics	なし	age / gender / area	友だち属性の分布を取得する
line_message_interaction	request_id	clicks / opens	メッセージ配信の反応を取得する

フィールド

ID	型	表示名	媒体側API名	説明
GetFriendsDemographicsResponse.available	api_schema_field	Available	LINE Insight OpenAPI GetFriendsDemographicsResponse.available (boolean)	true if friend demographic information is available.
GetFriendsDemographicsResponse.genders	api_schema_field	Genders	LINE Insight OpenAPI GetFriendsDemographicsResponse.genders (array)	Percentage per gender.
GetFriendsDemographicsResponse.genders.gender	api_schema_field	Gender	LINE Insight OpenAPI GenderTile.gender (string)	users' gender
GetFriendsDemographicsResponse.genders.percentage	api_schema_field	Percentage	LINE Insight OpenAPI GenderTile.percentage (number)	Percentage
GetFriendsDemographicsResponse.ages	api_schema_field	Ages	LINE Insight OpenAPI GetFriendsDemographicsResponse.ages (array)	Percentage per age group.
GetFriendsDemographicsResponse.ages.age	api_schema_field	Age	LINE Insight OpenAPI AgeTile.age (string)	users' age
GetFriendsDemographicsResponse.ages.percentage	api_schema_field	Percentage	LINE Insight OpenAPI AgeTile.percentage (number)	Percentage
GetFriendsDemographicsResponse.areas	api_schema_field	Areas	LINE Insight OpenAPI GetFriendsDemographicsResponse.areas (array)	Percentage per area.
GetFriendsDemographicsResponse.areas.area	api_schema_field	Area	LINE Insight OpenAPI AreaTile.area (string)	users' country and region
GetFriendsDemographicsResponse.areas.percentage	api_schema_field	Percentage	LINE Insight OpenAPI AreaTile.percentage (number)	Percentage
GetFriendsDemographicsResponse.appTypes	api_schema_field	App Types	LINE Insight OpenAPI GetFriendsDemographicsResponse.appTypes (array)	Percentage by OS.
GetFriendsDemographicsResponse.appTypes.appType	api_schema_field	App Type	LINE Insight OpenAPI AppTypeTile.appType (string)	users' OS
GetFriendsDemographicsResponse.appTypes.percentage	api_schema_field	Percentage	LINE Insight OpenAPI AppTypeTile.percentage (number)	Percentage
GetFriendsDemographicsResponse.subscriptionPeriods	api_schema_field	Subscription Periods	LINE Insight OpenAPI GetFriendsDemographicsResponse.subscriptionPeriods (array)	Percentage per friendship duration.
GetFriendsDemographicsResponse.subscriptionPeriods.subscriptionPeriod	api_schema_field	Subscription Period	LINE Insight OpenAPI SubscriptionPeriodTile.subscriptionPeriod (string)	Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc.
GetFriendsDemographicsResponse.subscriptionPeriods.percentage	api_schema_field	Percentage	LINE Insight OpenAPI SubscriptionPeriodTile.percentage (number)	Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
GetMessageEventResponse.overview	api_schema_field	Overview	LINE Insight OpenAPI GetMessageEventResponse.overview (object)	GetMessageEventResponse.overview schema field
GetMessageEventResponse.overview.requestId	api_schema_field	Request Id	LINE Insight OpenAPI GetMessageEventResponseOverview.requestId (string)	Request ID.
GetMessageEventResponse.overview.timestamp	api_schema_field	Timestamp	LINE Insight OpenAPI GetMessageEventResponseOverview.timestamp (integer)	UNIX timestamp for message delivery time in seconds.
GetMessageEventResponse.overview.delivered	api_schema_field	Delivered	LINE Insight OpenAPI GetMessageEventResponseOverview.delivered (integer)	Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
GetMessageEventResponse.overview.uniqueImpression	api_schema_field	Unique Impression	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueImpression (integer)	Number of users who opened the message, meaning they displayed at least 1 bubble.
GetMessageEventResponse.overview.uniqueClick	api_schema_field	Unique Click	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueClick (integer)	Number of users who opened any URL in the message.
GetMessageEventResponse.overview.uniqueMediaPlayed	api_schema_field	Unique Media Played	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueMediaPlayed (integer)	Number of users who started playing any video or audio in the message.
GetMessageEventResponse.overview.uniqueMediaPlayed100Percent	api_schema_field	Unique Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueMediaPlayed100Percent (integer)	Number of users who played the entirety of any video or audio in the message.
GetMessageEventResponse.messages	api_schema_field	Messages	LINE Insight OpenAPI GetMessageEventResponse.messages (array)	Array of information about individual message bubbles.
GetMessageEventResponse.messages.seq	api_schema_field	Seq	LINE Insight OpenAPI GetMessageEventResponseMessage.seq (integer)	Bubble's serial number.
GetMessageEventResponse.messages.impression	api_schema_field	Impression	LINE Insight OpenAPI GetMessageEventResponseMessage.impression (integer)	Number of times the bubble was displayed.
GetMessageEventResponse.messages.mediaPlayed	api_schema_field	Media Played	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed (integer)	Number of times audio or video in the bubble started playing.
GetMessageEventResponse.messages.mediaPlayed25Percent	api_schema_field	Media Played25 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed25Percent (integer)	Number of times audio or video in the bubble started playing and was played 25% of the total time.
GetMessageEventResponse.messages.mediaPlayed50Percent	api_schema_field	Media Played50 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed50Percent (integer)	Number of times audio or video in the bubble started playing and was played 50% of the total time.
GetMessageEventResponse.messages.mediaPlayed75Percent	api_schema_field	Media Played75 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed75Percent (integer)	Number of times audio or video in the bubble started playing and was played 75% of the total time.
GetMessageEventResponse.messages.mediaPlayed100Percent	api_schema_field	Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed100Percent (integer)	Number of times audio or video in the bubble started playing and was played 100% of the total time.
GetMessageEventResponse.messages.uniqueMediaPlayed	api_schema_field	Unique Media Played	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed (integer)	Number of users that started playing audio or video in the bubble.
GetMessageEventResponse.messages.uniqueMediaPlayed25Percent	api_schema_field	Unique Media Played25 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed25Percent (integer)	Number of users that started playing audio or video in the bubble and played 25% of the total time.
GetMessageEventResponse.messages.uniqueMediaPlayed50Percent	api_schema_field	Unique Media Played50 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed50Percent (integer)	Number of users that started playing audio or video in the bubble and played 50% of the total time.
GetMessageEventResponse.messages.uniqueMediaPlayed75Percent	api_schema_field	Unique Media Played75 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed75Percent (integer)	Number of users that started playing audio or video in the bubble and played 75% of the total time.
GetMessageEventResponse.messages.uniqueMediaPlayed100Percent	api_schema_field	Unique Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed100Percent (integer)	Number of users that started playing audio or video in the bubble and played 100% of the total time.
GetMessageEventResponse.clicks	api_schema_field	Clicks	LINE Insight OpenAPI GetMessageEventResponse.clicks (array)	Array of information about opened URLs in the message.
GetMessageEventResponse.clicks.seq	api_schema_field	Seq	LINE Insight OpenAPI GetMessageEventResponseClick.seq (integer)	The URL's serial number.
GetMessageEventResponse.clicks.url	api_schema_field	Url	LINE Insight OpenAPI GetMessageEventResponseClick.url (string)	URL.
GetMessageEventResponse.clicks.click	api_schema_field	Click	LINE Insight OpenAPI GetMessageEventResponseClick.click (integer)	Number of times the URL was opened.
GetMessageEventResponse.clicks.uniqueClick	api_schema_field	Unique Click	LINE Insight OpenAPI GetMessageEventResponseClick.uniqueClick (integer)	Number of users that opened the URL.
GetMessageEventResponse.clicks.uniqueClickOfRequest	api_schema_field	Unique Click Of Request	LINE Insight OpenAPI GetMessageEventResponseClick.uniqueClickOfRequest (integer)	Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
GetMessageEventResponseClick.seq	api_schema_field	Seq	LINE Insight OpenAPI GetMessageEventResponseClick.seq (integer)	The URL's serial number.
GetMessageEventResponseClick.url	api_schema_field	Url	LINE Insight OpenAPI GetMessageEventResponseClick.url (string)	URL.
GetMessageEventResponseClick.click	api_schema_field	Click	LINE Insight OpenAPI GetMessageEventResponseClick.click (integer)	Number of times the URL was opened.
GetMessageEventResponseClick.uniqueClick	api_schema_field	Unique Click	LINE Insight OpenAPI GetMessageEventResponseClick.uniqueClick (integer)	Number of users that opened the URL.
GetMessageEventResponseClick.uniqueClickOfRequest	api_schema_field	Unique Click Of Request	LINE Insight OpenAPI GetMessageEventResponseClick.uniqueClickOfRequest (integer)	Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
GetMessageEventResponseMessage.seq	api_schema_field	Seq	LINE Insight OpenAPI GetMessageEventResponseMessage.seq (integer)	Bubble's serial number.
GetMessageEventResponseMessage.impression	api_schema_field	Impression	LINE Insight OpenAPI GetMessageEventResponseMessage.impression (integer)	Number of times the bubble was displayed.
GetMessageEventResponseMessage.mediaPlayed	api_schema_field	Media Played	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed (integer)	Number of times audio or video in the bubble started playing.
GetMessageEventResponseMessage.mediaPlayed25Percent	api_schema_field	Media Played25 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed25Percent (integer)	Number of times audio or video in the bubble started playing and was played 25% of the total time.
GetMessageEventResponseMessage.mediaPlayed50Percent	api_schema_field	Media Played50 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed50Percent (integer)	Number of times audio or video in the bubble started playing and was played 50% of the total time.
GetMessageEventResponseMessage.mediaPlayed75Percent	api_schema_field	Media Played75 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed75Percent (integer)	Number of times audio or video in the bubble started playing and was played 75% of the total time.
GetMessageEventResponseMessage.mediaPlayed100Percent	api_schema_field	Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.mediaPlayed100Percent (integer)	Number of times audio or video in the bubble started playing and was played 100% of the total time.
GetMessageEventResponseMessage.uniqueMediaPlayed	api_schema_field	Unique Media Played	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed (integer)	Number of users that started playing audio or video in the bubble.
GetMessageEventResponseMessage.uniqueMediaPlayed25Percent	api_schema_field	Unique Media Played25 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed25Percent (integer)	Number of users that started playing audio or video in the bubble and played 25% of the total time.
GetMessageEventResponseMessage.uniqueMediaPlayed50Percent	api_schema_field	Unique Media Played50 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed50Percent (integer)	Number of users that started playing audio or video in the bubble and played 50% of the total time.
GetMessageEventResponseMessage.uniqueMediaPlayed75Percent	api_schema_field	Unique Media Played75 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed75Percent (integer)	Number of users that started playing audio or video in the bubble and played 75% of the total time.
GetMessageEventResponseMessage.uniqueMediaPlayed100Percent	api_schema_field	Unique Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseMessage.uniqueMediaPlayed100Percent (integer)	Number of users that started playing audio or video in the bubble and played 100% of the total time.
GetMessageEventResponseOverview.requestId	api_schema_field	Request Id	LINE Insight OpenAPI GetMessageEventResponseOverview.requestId (string)	Request ID.
GetMessageEventResponseOverview.timestamp	api_schema_field	Timestamp	LINE Insight OpenAPI GetMessageEventResponseOverview.timestamp (integer)	UNIX timestamp for message delivery time in seconds.
GetMessageEventResponseOverview.delivered	api_schema_field	Delivered	LINE Insight OpenAPI GetMessageEventResponseOverview.delivered (integer)	Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
GetMessageEventResponseOverview.uniqueImpression	api_schema_field	Unique Impression	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueImpression (integer)	Number of users who opened the message, meaning they displayed at least 1 bubble.
GetMessageEventResponseOverview.uniqueClick	api_schema_field	Unique Click	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueClick (integer)	Number of users who opened any URL in the message.
GetMessageEventResponseOverview.uniqueMediaPlayed	api_schema_field	Unique Media Played	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueMediaPlayed (integer)	Number of users who started playing any video or audio in the message.
GetMessageEventResponseOverview.uniqueMediaPlayed100Percent	api_schema_field	Unique Media Played100 Percent	LINE Insight OpenAPI GetMessageEventResponseOverview.uniqueMediaPlayed100Percent (integer)	Number of users who played the entirety of any video or audio in the message.
GetNumberOfFollowersResponse.status	api_schema_field	Status	LINE Insight OpenAPI GetNumberOfFollowersResponse.status (string)	Calculation status.
GetNumberOfFollowersResponse.followers	api_schema_field	Followers	LINE Insight OpenAPI GetNumberOfFollowersResponse.followers (integer)	The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account.
GetNumberOfFollowersResponse.targetedReaches	api_schema_field	Targeted Reaches	LINE Insight OpenAPI GetNumberOfFollowersResponse.targetedReaches (integer)	The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high l…
GetNumberOfFollowersResponse.blocks	api_schema_field	Blocks	LINE Insight OpenAPI GetNumberOfFollowersResponse.blocks (integer)	The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.
GetNumberOfMessageDeliveriesResponse.status	api_schema_field	Status	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.status (string)	Status of the counting process.
GetNumberOfMessageDeliveriesResponse.broadcast	api_schema_field	Broadcast	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.broadcast (integer)	Number of messages sent to all of this LINE Official Account's friends (broadcast messages).
GetNumberOfMessageDeliveriesResponse.targeting	api_schema_field	Targeting	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.targeting (integer)	Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages).
GetNumberOfMessageDeliveriesResponse.autoResponse	api_schema_field	Auto Response	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.autoResponse (integer)	Number of auto-response messages sent.
GetNumberOfMessageDeliveriesResponse.welcomeResponse	api_schema_field	Welcome Response	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.welcomeResponse (integer)	Number of greeting messages sent.
GetNumberOfMessageDeliveriesResponse.chat	api_schema_field	Chat	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.chat (integer)	Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese).
GetNumberOfMessageDeliveriesResponse.apiBroadcast	api_schema_field	Api Broadcast	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.apiBroadcast (integer)	Number of broadcast messages sent with the `Send broadcast message` Messaging API operation.
GetNumberOfMessageDeliveriesResponse.apiPush	api_schema_field	Api Push	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.apiPush (integer)	Number of push messages sent with the `Send push message` Messaging API operation.
GetNumberOfMessageDeliveriesResponse.apiMulticast	api_schema_field	Api Multicast	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.apiMulticast (integer)	Number of multicast messages sent with the `Send multicast message` Messaging API operation.
GetNumberOfMessageDeliveriesResponse.apiNarrowcast	api_schema_field	Api Narrowcast	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.apiNarrowcast (integer)	Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation.
GetNumberOfMessageDeliveriesResponse.apiReply	api_schema_field	Api Reply	LINE Insight OpenAPI GetNumberOfMessageDeliveriesResponse.apiReply (integer)	Number of replies sent with the `Send reply message` Messaging API operation.
GetRichMenuInsightDailyResponse.richMenuId	api_schema_field	Rich Menu Id	LINE Insight OpenAPI GetRichMenuInsightDailyResponse.richMenuId (string)	Rich menu ID.
GetRichMenuInsightDailyResponse.metricsFrom	api_schema_field	Metrics From	LINE Insight OpenAPI GetRichMenuInsightDailyResponse.metricsFrom (string)	Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponse.metricsTo	api_schema_field	Metrics To	LINE Insight OpenAPI GetRichMenuInsightDailyResponse.metricsTo (string)	End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260215).
GetRichMenuInsightDailyResponse.impression	api_schema_field	Impression	LINE Insight OpenAPI GetRichMenuInsightDailyResponse.impression (object)	GetRichMenuInsightDailyResponse.impression schema field
GetRichMenuInsightDailyResponse.impression.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightDailyResponseImpression.metrics (array)	Per-day impression metrics.
GetRichMenuInsightDailyResponse.impression.metrics.date	api_schema_field	Date	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.date (string)	The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponse.impression.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.count (integer)	Number of impressions or clicks on this day.
GetRichMenuInsightDailyResponse.impression.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click on this day.
GetRichMenuInsightDailyResponse.clicks	api_schema_field	Clicks	LINE Insight OpenAPI GetRichMenuInsightDailyResponse.clicks (array)	Daily click metrics for each tappable area of the rich menu.
GetRichMenuInsightDailyResponse.clicks.bounds	api_schema_field	Bounds	LINE Insight OpenAPI GetRichMenuInsightDailyResponseClick.bounds (object)	GetRichMenuInsightDailyResponseClick.bounds schema field
GetRichMenuInsightDailyResponse.clicks.bounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponse.clicks.bounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponse.clicks.bounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightDailyResponse.clicks.bounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightDailyResponse.clicks.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightDailyResponseClick.metrics (array)	Per-day click metrics for the target area.
GetRichMenuInsightDailyResponse.clicks.metrics.date	api_schema_field	Date	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.date (string)	The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponse.clicks.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.count (integer)	Number of impressions or clicks on this day.
GetRichMenuInsightDailyResponse.clicks.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click on this day.
GetRichMenuInsightDailyResponseBounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponseBounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponseBounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightDailyResponseBounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightDailyResponseClick.bounds	api_schema_field	Bounds	LINE Insight OpenAPI GetRichMenuInsightDailyResponseClick.bounds (object)	GetRichMenuInsightDailyResponseClick.bounds schema field
GetRichMenuInsightDailyResponseClick.bounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponseClick.bounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightDailyResponseClick.bounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightDailyResponseClick.bounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightDailyResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightDailyResponseClick.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightDailyResponseClick.metrics (array)	Per-day click metrics for the target area.
GetRichMenuInsightDailyResponseClick.metrics.date	api_schema_field	Date	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.date (string)	The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponseClick.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.count (integer)	Number of impressions or clicks on this day.
GetRichMenuInsightDailyResponseClick.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click on this day.
GetRichMenuInsightDailyResponseDailyMetrics.date	api_schema_field	Date	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.date (string)	The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponseDailyMetrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.count (integer)	Number of impressions or clicks on this day.
GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click on this day.
GetRichMenuInsightDailyResponseImpression.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightDailyResponseImpression.metrics (array)	Per-day impression metrics.
GetRichMenuInsightDailyResponseImpression.metrics.date	api_schema_field	Date	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.date (string)	The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightDailyResponseImpression.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.count (integer)	Number of impressions or clicks on this day.
GetRichMenuInsightDailyResponseImpression.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightDailyResponseDailyMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click on this day.
GetRichMenuInsightSummaryResponse.richMenuId	api_schema_field	Rich Menu Id	LINE Insight OpenAPI GetRichMenuInsightSummaryResponse.richMenuId (string)	Rich menu ID.
GetRichMenuInsightSummaryResponse.metricsFrom	api_schema_field	Metrics From	LINE Insight OpenAPI GetRichMenuInsightSummaryResponse.metricsFrom (string)	Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260213).
GetRichMenuInsightSummaryResponse.metricsTo	api_schema_field	Metrics To	LINE Insight OpenAPI GetRichMenuInsightSummaryResponse.metricsTo (string)	End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260215).
GetRichMenuInsightSummaryResponse.impression	api_schema_field	Impression	LINE Insight OpenAPI GetRichMenuInsightSummaryResponse.impression (object)	GetRichMenuInsightSummaryResponse.impression schema field
GetRichMenuInsightSummaryResponse.impression.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseImpression.metrics (object)	GetRichMenuInsightSummaryResponseImpression.metrics schema field
GetRichMenuInsightSummaryResponse.impression.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.count (integer)	Number of impressions or clicks.
GetRichMenuInsightSummaryResponse.impression.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click.
GetRichMenuInsightSummaryResponse.clicks	api_schema_field	Clicks	LINE Insight OpenAPI GetRichMenuInsightSummaryResponse.clicks (array)	Click metrics for each tappable area of the rich menu.
GetRichMenuInsightSummaryResponse.clicks.bounds	api_schema_field	Bounds	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseClick.bounds (object)	GetRichMenuInsightSummaryResponseClick.bounds schema field
GetRichMenuInsightSummaryResponse.clicks.bounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponse.clicks.bounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponse.clicks.bounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightSummaryResponse.clicks.bounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightSummaryResponse.clicks.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseClick.metrics (object)	GetRichMenuInsightSummaryResponseClick.metrics schema field
GetRichMenuInsightSummaryResponse.clicks.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.count (integer)	Number of impressions or clicks.
GetRichMenuInsightSummaryResponse.clicks.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click.
GetRichMenuInsightSummaryResponseBounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponseBounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponseBounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightSummaryResponseBounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightSummaryResponseClick.bounds	api_schema_field	Bounds	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseClick.bounds (object)	GetRichMenuInsightSummaryResponseClick.bounds schema field
GetRichMenuInsightSummaryResponseClick.bounds.x	api_schema_field	X	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.x (integer)	The x coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponseClick.bounds.y	api_schema_field	Y	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.y (integer)	The y coordinate of the top-left corner of the target area.
GetRichMenuInsightSummaryResponseClick.bounds.width	api_schema_field	Width	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.width (integer)	The width of the target area.
GetRichMenuInsightSummaryResponseClick.bounds.height	api_schema_field	Height	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseBounds.height (integer)	The height of the target area.
GetRichMenuInsightSummaryResponseClick.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseClick.metrics (object)	GetRichMenuInsightSummaryResponseClick.metrics schema field
GetRichMenuInsightSummaryResponseClick.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.count (integer)	Number of impressions or clicks.
GetRichMenuInsightSummaryResponseClick.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click.
GetRichMenuInsightSummaryResponseImpression.metrics	api_schema_field	Metrics	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseImpression.metrics (object)	GetRichMenuInsightSummaryResponseImpression.metrics schema field
GetRichMenuInsightSummaryResponseImpression.metrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.count (integer)	Number of impressions or clicks.
GetRichMenuInsightSummaryResponseImpression.metrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click.
GetRichMenuInsightSummaryResponseMetrics.count	api_schema_field	Count	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.count (integer)	Number of impressions or clicks.
GetRichMenuInsightSummaryResponseMetrics.uniqueUsers	api_schema_field	Unique Users	LINE Insight OpenAPI GetRichMenuInsightSummaryResponseMetrics.uniqueUsers (integer)	Approximate number of unique users who triggered an impression or click.
GetStatisticsPerUnitResponseMessage.seq	api_schema_field	Seq	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.seq (integer)	Bubble's serial number.
GetStatisticsPerUnitResponseMessage.impression	api_schema_field	Impression	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.impression (integer)	Number of times the bubble was displayed.
GetStatisticsPerUnitResponseMessage.mediaPlayed	api_schema_field	Media Played	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.mediaPlayed (integer)	Number of times audio or video in the bubble started playing.
GetStatisticsPerUnitResponseMessage.mediaPlayed25Percent	api_schema_field	Media Played25 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.mediaPlayed25Percent (integer)	Number of times audio or video in the bubble started playing and was played 25% of the total time.
GetStatisticsPerUnitResponseMessage.mediaPlayed50Percent	api_schema_field	Media Played50 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.mediaPlayed50Percent (integer)	Number of times audio or video in the bubble started playing and was played 50% of the total time.
GetStatisticsPerUnitResponseMessage.mediaPlayed75Percent	api_schema_field	Media Played75 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.mediaPlayed75Percent (integer)	Number of times audio or video in the bubble started playing and was played 75% of the total time.
GetStatisticsPerUnitResponseMessage.mediaPlayed100Percent	api_schema_field	Media Played100 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.mediaPlayed100Percent (integer)	Number of times audio or video in the bubble started playing and was played 100% of the total time.
GetStatisticsPerUnitResponseMessage.uniqueImpression	api_schema_field	Unique Impression	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueImpression (integer)	Number of users the bubble was displayed.
GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed	api_schema_field	Unique Media Played	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed (integer)	Number of users that started playing audio or video in the bubble.
GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed25Percent	api_schema_field	Unique Media Played25 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed25Percent (integer)	Number of users that started playing audio or video in the bubble and played 25% of the total time.
GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed50Percent	api_schema_field	Unique Media Played50 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed50Percent (integer)	Number of users that started playing audio or video in the bubble and played 50% of the total time.
GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed75Percent	api_schema_field	Unique Media Played75 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed75Percent (integer)	Number of users that started playing audio or video in the bubble and played 75% of the total time.
GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed100Percent	api_schema_field	Unique Media Played100 Percent	LINE Insight OpenAPI GetStatisticsPerUnitResponseMessage.uniqueMediaPlayed100Percent (integer)	Number of users that started playing audio or video in the bubble and played 100% of the total time.
userId	bot_info_field	BotユーザーID	/v2/bot/info userId	LINE公式アカウントのBotユーザーIDです。
basicId	bot_info_field	Basic ID	/v2/bot/info basicId	LINE公式アカウントのBasic IDです。
premiumId	bot_info_field	Premium ID	/v2/bot/info premiumId	LINE公式アカウントのPremium IDです。
displayName	bot_info_field	表示名	/v2/bot/info displayName	LINE公式アカウントの表示名です。
chatMode	bot_info_field	チャットモード	/v2/bot/info chatMode	チャットモードです。
markAsReadMode	bot_info_field	既読モード	/v2/bot/info markAsReadMode	既読処理モードです。

スプレッドシート

ドキュメント / Google Picker + OAuth

提供中

選択されたGoogleスプレッドシートのタブとセル範囲を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_spreadsheets	なし	spreadsheet_id / name / tabs	接続済みシートを一覧化する
read_spreadsheet	range_a1, spreadsheet_id	range / values	指定範囲のセルを読み取る

フィールド

ID	型	表示名	媒体側API名	説明
Spreadsheet.dataSources	api_schema_field	Data Sources	Spreadsheet.dataSources (array)	A list of external data sources connected with the spreadsheet.
Spreadsheet.dataSources.spec	api_schema_field	Spec	DataSource.spec (object)	The DataSourceSpec for the data source connected with this spreadsheet.
Spreadsheet.dataSources.spec.bigQuery	api_schema_field	Big Query	DataSourceSpec.bigQuery (object)	A BigQueryDataSourceSpec.
Spreadsheet.dataSources.spec.bigQuery.querySpec	api_schema_field	Query Spec	BigQueryDataSourceSpec.querySpec (object)	A BigQueryQuerySpec.
Spreadsheet.dataSources.spec.bigQuery.tableSpec	api_schema_field	Table Spec	BigQueryDataSourceSpec.tableSpec (object)	A BigQueryTableSpec.
Spreadsheet.dataSources.spec.bigQuery.projectId	api_schema_field	Project Id	BigQueryDataSourceSpec.projectId (string)	The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.
Spreadsheet.dataSources.spec.looker	api_schema_field	Looker	DataSourceSpec.looker (object)	A LookerDatasourceSpec.
Spreadsheet.dataSources.spec.looker.model	api_schema_field	Model	LookerDataSourceSpec.model (string)	Name of a Looker model.
Spreadsheet.dataSources.spec.looker.instanceUri	api_schema_field	Instance Uri	LookerDataSourceSpec.instanceUri (string)	A Looker instance URL.
Spreadsheet.dataSources.spec.looker.explore	api_schema_field	Explore	LookerDataSourceSpec.explore (string)	Name of a Looker model explore.
Spreadsheet.dataSources.spec.parameters	api_schema_field	Parameters	DataSourceSpec.parameters (array)	The parameters of the data source, used when querying the data source.
Spreadsheet.dataSources.spec.parameters.range	api_schema_field	Range	DataSourceParameter.range (object)	A range that contains the value of the parameter. Its size must be 1x1.
Spreadsheet.dataSources.spec.parameters.name	schema_pii_or_identity_field	Name	DataSourceParameter.name (string)	Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers).
Spreadsheet.dataSources.spec.parameters.namedRangeId	schema_pii_or_identity_field	Named Range Id	DataSourceParameter.namedRangeId (string)	ID of a NamedRange. Its size must be 1x1.
Spreadsheet.dataSources.calculatedColumns	api_schema_field	Calculated Columns	DataSource.calculatedColumns (array)	All calculated columns in the data source.
Spreadsheet.dataSources.calculatedColumns.formula	api_schema_field	Formula	DataSourceColumn.formula (string)	The formula of the calculated column.
Spreadsheet.dataSources.calculatedColumns.reference	api_schema_field	Reference	DataSourceColumn.reference (object)	The column reference.
Spreadsheet.dataSources.calculatedColumns.reference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Spreadsheet.dataSources.sheetId	api_schema_field	Sheet Id	DataSource.sheetId (integer)	The ID of the Sheet connected with the data source. The field cannot be changed once set. When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.
Spreadsheet.dataSources.dataSourceId	api_schema_field	Data Source Id	DataSource.dataSourceId (string)	The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.
Spreadsheet.sheets	api_schema_field	Sheets	Spreadsheet.sheets (array)	The sheets that are part of a spreadsheet.
Spreadsheet.sheets.basicFilter	api_schema_field	Basic Filter	Sheet.basicFilter (object)	The filter on this sheet, if any.
Spreadsheet.sheets.basicFilter.sortSpecs	api_schema_field	Sort Specs	BasicFilter.sortSpecs (array)	The sort order per column. Later specifications are used when values are equal in the earlier specifications.
Spreadsheet.sheets.basicFilter.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
Spreadsheet.sheets.basicFilter.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
Spreadsheet.sheets.basicFilter.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
Spreadsheet.sheets.basicFilter.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
Spreadsheet.sheets.basicFilter.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
Spreadsheet.sheets.basicFilter.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
Spreadsheet.sheets.basicFilter.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
Spreadsheet.sheets.basicFilter.filterSpecs	api_schema_field	Filter Specs	BasicFilter.filterSpecs (array)	The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
Spreadsheet.sheets.basicFilter.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
Spreadsheet.sheets.basicFilter.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
Spreadsheet.sheets.basicFilter.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
Spreadsheet.sheets.basicFilter.range	api_schema_field	Range	BasicFilter.range (object)	The range the filter covers.
Spreadsheet.sheets.basicFilter.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.basicFilter.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.basicFilter.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.basicFilter.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.basicFilter.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.basicFilter.tableId	api_schema_field	Table Id	BasicFilter.tableId (string)	The table this filter is backed by, if any. When writing, only one of range or table_id may be set.
Spreadsheet.sheets.basicFilter.criteria	api_schema_field	Criteria	BasicFilter.criteria (object)	The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.
Spreadsheet.sheets.properties	api_schema_field	Properties	Sheet.properties (object)	The properties of the sheet.
Spreadsheet.sheets.properties.title	api_schema_field	Title	SheetProperties.title (string)	The name of the sheet.
Spreadsheet.sheets.properties.gridProperties	api_schema_field	Grid Properties	SheetProperties.gridProperties (object)	Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOUR…
Spreadsheet.sheets.properties.gridProperties.frozenColumnCount	api_schema_field	Frozen Column Count	GridProperties.frozenColumnCount (integer)	The number of columns that are frozen in the grid.
Spreadsheet.sheets.properties.gridProperties.hideGridlines	api_schema_field	Hide Gridlines	GridProperties.hideGridlines (boolean)	True if the grid isn't showing gridlines in the UI.
Spreadsheet.sheets.properties.gridProperties.rowCount	api_schema_field	Row Count	GridProperties.rowCount (integer)	The number of rows in the grid.
Spreadsheet.sheets.properties.gridProperties.columnCount	api_schema_field	Column Count	GridProperties.columnCount (integer)	The number of columns in the grid.
Spreadsheet.sheets.properties.gridProperties.columnGroupControlAfter	api_schema_field	Column Group Control After	GridProperties.columnGroupControlAfter (boolean)	True if the column grouping control toggle is shown after the group.
Spreadsheet.sheets.properties.gridProperties.frozenRowCount	api_schema_field	Frozen Row Count	GridProperties.frozenRowCount (integer)	The number of rows that are frozen in the grid.
Spreadsheet.sheets.properties.gridProperties.rowGroupControlAfter	api_schema_field	Row Group Control After	GridProperties.rowGroupControlAfter (boolean)	True if the row grouping control toggle is shown after the group.
Spreadsheet.sheets.properties.tabColor	api_schema_field	Tab Color	SheetProperties.tabColor (object)	The color of the tab in the UI. Deprecated: Use tab_color_style.
Spreadsheet.sheets.properties.tabColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Spreadsheet.sheets.properties.tabColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Spreadsheet.sheets.properties.tabColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Spreadsheet.sheets.properties.tabColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Spreadsheet.sheets.properties.hidden	api_schema_field	Hidden	SheetProperties.hidden (boolean)	True if the sheet is hidden in the UI, false if it's visible.
Spreadsheet.sheets.properties.sheetType	api_schema_field	Sheet Type	SheetProperties.sheetType (string)	The type of sheet. Defaults to GRID. This field cannot be changed once set.
Spreadsheet.sheets.properties.dataSourceSheetProperties	api_schema_field	Data Source Sheet Properties	SheetProperties.dataSourceSheetProperties (object)	Output only. If present, the field contains DATA_SOURCE sheet specific properties.
Spreadsheet.sheets.properties.dataSourceSheetProperties.dataSourceId	api_schema_field	Data Source Id	DataSourceSheetProperties.dataSourceId (string)	ID of the DataSource the sheet is connected to.
Spreadsheet.sheets.properties.dataSourceSheetProperties.columns	api_schema_field	Columns	DataSourceSheetProperties.columns (array)	The columns displayed on the sheet, corresponding to the values in RowData.
Spreadsheet.sheets.properties.dataSourceSheetProperties.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceSheetProperties.dataExecutionStatus (object)	The data execution status.
Spreadsheet.sheets.properties.index	api_schema_field	Index	SheetProperties.index (integer)	The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "befor…
Spreadsheet.sheets.properties.sheetId	api_schema_field	Sheet Id	SheetProperties.sheetId (integer)	The ID of the sheet. Must be non-negative. This field cannot be changed once set.
Spreadsheet.sheets.properties.rightToLeft	api_schema_field	Right To Left	SheetProperties.rightToLeft (boolean)	True if the sheet is an RTL sheet instead of an LTR sheet.
Spreadsheet.sheets.properties.tabColorStyle	api_schema_field	Tab Color Style	SheetProperties.tabColorStyle (object)	The color of the tab in the UI. If tab_color is also set, this field takes precedence.
Spreadsheet.sheets.properties.tabColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Spreadsheet.sheets.properties.tabColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Spreadsheet.sheets.columnGroups	api_schema_field	Column Groups	Sheet.columnGroups (array)	All column groups on this sheet, ordered by increasing range start index, then by group depth.
Spreadsheet.sheets.columnGroups.depth	api_schema_field	Depth	DimensionGroup.depth (integer)	The depth of the group, representing how many groups have a range that wholly contains the range of this group.
Spreadsheet.sheets.columnGroups.collapsed	api_schema_field	Collapsed	DimensionGroup.collapsed (boolean)	This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change…
Spreadsheet.sheets.columnGroups.range	api_schema_field	Range	DimensionGroup.range (object)	The range over which this group exists.
Spreadsheet.sheets.columnGroups.range.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Spreadsheet.sheets.columnGroups.range.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Spreadsheet.sheets.columnGroups.range.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Spreadsheet.sheets.columnGroups.range.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Spreadsheet.sheets.charts	api_schema_field	Charts	Sheet.charts (array)	The specifications of every chart on this sheet.
Spreadsheet.sheets.charts.chartId	api_schema_field	Chart Id	EmbeddedChart.chartId (integer)	The ID of the chart.
Spreadsheet.sheets.charts.spec	api_schema_field	Spec	EmbeddedChart.spec (object)	The specification of the chart.
Spreadsheet.sheets.charts.spec.hiddenDimensionStrategy	api_schema_field	Hidden Dimension Strategy	ChartSpec.hiddenDimensionStrategy (string)	Determines how the charts will use hidden rows or columns.
Spreadsheet.sheets.charts.spec.orgChart	api_schema_field	Org Chart	ChartSpec.orgChart (object)	An org chart specification.
Spreadsheet.sheets.charts.spec.title	api_schema_field	Title	ChartSpec.title (string)	The title of the chart.
Spreadsheet.sheets.charts.spec.titleTextFormat	api_schema_field	Title Text Format	ChartSpec.titleTextFormat (object)	The title text format. Strikethrough, underline, and link are not supported.
Spreadsheet.sheets.charts.spec.maximized	api_schema_field	Maximized	ChartSpec.maximized (boolean)	True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
Spreadsheet.sheets.charts.spec.dataSourceChartProperties	api_schema_field	Data Source Chart Properties	ChartSpec.dataSourceChartProperties (object)	If present, the field contains data source chart specific properties.
Spreadsheet.sheets.charts.spec.backgroundColorStyle	api_schema_field	Background Color Style	ChartSpec.backgroundColorStyle (object)	The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
Spreadsheet.sheets.charts.spec.filterSpecs	api_schema_field	Filter Specs	ChartSpec.filterSpecs (array)	The filters applied to the source data of the chart. Only supported for data source charts.
Spreadsheet.sheets.charts.spec.bubbleChart	api_schema_field	Bubble Chart	ChartSpec.bubbleChart (object)	A bubble chart specification.
Spreadsheet.sheets.charts.spec.histogramChart	api_schema_field	Histogram Chart	ChartSpec.histogramChart (object)	A histogram chart specification.
Spreadsheet.sheets.charts.spec.scorecardChart	api_schema_field	Scorecard Chart	ChartSpec.scorecardChart (object)	A scorecard chart specification.
Spreadsheet.sheets.charts.spec.waterfallChart	api_schema_field	Waterfall Chart	ChartSpec.waterfallChart (object)	A waterfall chart specification.
Spreadsheet.sheets.charts.spec.candlestickChart	api_schema_field	Candlestick Chart	ChartSpec.candlestickChart (object)	A candlestick chart specification.
Spreadsheet.sheets.charts.spec.altText	api_schema_field	Alt Text	ChartSpec.altText (string)	The alternative text that describes the chart. This is often used for accessibility.
Spreadsheet.sheets.charts.spec.basicChart	api_schema_field	Basic Chart	ChartSpec.basicChart (object)	A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
Spreadsheet.sheets.charts.spec.subtitle	api_schema_field	Subtitle	ChartSpec.subtitle (string)	The subtitle of the chart.
Spreadsheet.sheets.charts.spec.subtitleTextPosition	api_schema_field	Subtitle Text Position	ChartSpec.subtitleTextPosition (object)	The subtitle text position. This field is optional.
Spreadsheet.sheets.charts.spec.backgroundColor	api_schema_field	Background Color	ChartSpec.backgroundColor (object)	The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
Spreadsheet.sheets.charts.spec.pieChart	api_schema_field	Pie Chart	ChartSpec.pieChart (object)	A pie chart specification.
Spreadsheet.sheets.charts.spec.treemapChart	api_schema_field	Treemap Chart	ChartSpec.treemapChart (object)	A treemap chart specification.
Spreadsheet.sheets.charts.spec.fontName	schema_pii_or_identity_field	Font Name	ChartSpec.fontName (string)	The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
Spreadsheet.sheets.charts.spec.subtitleTextFormat	api_schema_field	Subtitle Text Format	ChartSpec.subtitleTextFormat (object)	The subtitle text format. Strikethrough, underline, and link are not supported.
Spreadsheet.sheets.charts.spec.sortSpecs	api_schema_field	Sort Specs	ChartSpec.sortSpecs (array)	The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
Spreadsheet.sheets.charts.spec.titleTextPosition	api_schema_field	Title Text Position	ChartSpec.titleTextPosition (object)	The title text position. This field is optional.
Spreadsheet.sheets.charts.position	api_schema_field	Position	EmbeddedChart.position (object)	The position of the chart.
Spreadsheet.sheets.charts.position.newSheet	api_schema_field	New Sheet	EmbeddedObjectPosition.newSheet (boolean)	If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.
Spreadsheet.sheets.charts.position.sheetId	api_schema_field	Sheet Id	EmbeddedObjectPosition.sheetId (integer)	The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.
Spreadsheet.sheets.charts.position.overlayPosition	api_schema_field	Overlay Position	EmbeddedObjectPosition.overlayPosition (object)	The position at which the object is overlaid on top of a grid.
Spreadsheet.sheets.charts.border	api_schema_field	Border	EmbeddedChart.border (object)	The border of the chart.
Spreadsheet.sheets.charts.border.color	api_schema_field	Color	EmbeddedObjectBorder.color (object)	The color of the border. Deprecated: Use color_style.
Spreadsheet.sheets.charts.border.colorStyle	api_schema_field	Color Style	EmbeddedObjectBorder.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
Spreadsheet.sheets.slicers	api_schema_field	Slicers	Sheet.slicers (array)	The slicers on this sheet.
Spreadsheet.sheets.slicers.spec	api_schema_field	Spec	Slicer.spec (object)	The specification of the slicer.
Spreadsheet.sheets.slicers.spec.backgroundColor	api_schema_field	Background Color	SlicerSpec.backgroundColor (object)	The background color of the slicer. Deprecated: Use background_color_style.
Spreadsheet.sheets.slicers.spec.columnIndex	api_schema_field	Column Index	SlicerSpec.columnIndex (integer)	The zero-based column index in the data table on which the filter is applied to.
Spreadsheet.sheets.slicers.spec.dataRange	api_schema_field	Data Range	SlicerSpec.dataRange (object)	The data range of the slicer.
Spreadsheet.sheets.slicers.spec.filterCriteria	api_schema_field	Filter Criteria	SlicerSpec.filterCriteria (object)	The filtering criteria of the slicer.
Spreadsheet.sheets.slicers.spec.applyToPivotTables	api_schema_field	Apply To Pivot Tables	SlicerSpec.applyToPivotTables (boolean)	True if the filter should apply to pivot tables. If not set, default to `True`.
Spreadsheet.sheets.slicers.spec.horizontalAlignment	api_schema_field	Horizontal Alignment	SlicerSpec.horizontalAlignment (string)	The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`
Spreadsheet.sheets.slicers.spec.textFormat	api_schema_field	Text Format	SlicerSpec.textFormat (object)	The text format of title in the slicer. The link field is not supported.
Spreadsheet.sheets.slicers.spec.title	api_schema_field	Title	SlicerSpec.title (string)	The title of the slicer.
Spreadsheet.sheets.slicers.spec.backgroundColorStyle	api_schema_field	Background Color Style	SlicerSpec.backgroundColorStyle (object)	The background color of the slicer. If background_color is also set, this field takes precedence.
Spreadsheet.sheets.slicers.position	api_schema_field	Position	Slicer.position (object)	The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits.
Spreadsheet.sheets.slicers.position.newSheet	api_schema_field	New Sheet	EmbeddedObjectPosition.newSheet (boolean)	If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.
Spreadsheet.sheets.slicers.position.sheetId	api_schema_field	Sheet Id	EmbeddedObjectPosition.sheetId (integer)	The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.
Spreadsheet.sheets.slicers.position.overlayPosition	api_schema_field	Overlay Position	EmbeddedObjectPosition.overlayPosition (object)	The position at which the object is overlaid on top of a grid.
Spreadsheet.sheets.slicers.slicerId	api_schema_field	Slicer Id	Slicer.slicerId (integer)	The ID of the slicer.
Spreadsheet.sheets.protectedRanges	api_schema_field	Protected Ranges	Sheet.protectedRanges (array)	The protected ranges in this sheet.
Spreadsheet.sheets.protectedRanges.tableId	api_schema_field	Table Id	ProtectedRange.tableId (string)	The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.
Spreadsheet.sheets.protectedRanges.namedRangeId	schema_pii_or_identity_field	Named Range Id	ProtectedRange.namedRangeId (string)	The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.
Spreadsheet.sheets.protectedRanges.unprotectedRanges	api_schema_field	Unprotected Ranges	ProtectedRange.unprotectedRanges (array)	The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.
Spreadsheet.sheets.protectedRanges.unprotectedRanges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.protectedRanges.unprotectedRanges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.unprotectedRanges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.unprotectedRanges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.unprotectedRanges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.editors	api_schema_field	Editors	ProtectedRange.editors (object)	The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection.
Spreadsheet.sheets.protectedRanges.editors.domainUsersCanEdit	api_schema_field	Domain Users Can Edit	Editors.domainUsersCanEdit (boolean)	True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.
Spreadsheet.sheets.protectedRanges.editors.users	api_schema_field	Users	Editors.users (array)	The email addresses of users with edit access to the protected range.
Spreadsheet.sheets.protectedRanges.editors.groups	api_schema_field	Groups	Editors.groups (array)	The email addresses of groups with edit access to the protected range.
Spreadsheet.sheets.protectedRanges.protectedRangeId	api_schema_field	Protected Range Id	ProtectedRange.protectedRangeId (integer)	The ID of the protected range. This field is read-only.
Spreadsheet.sheets.protectedRanges.range	api_schema_field	Range	ProtectedRange.range (object)	The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set.
Spreadsheet.sheets.protectedRanges.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.protectedRanges.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.protectedRanges.requestingUserCanEdit	api_schema_field	Requesting User Can Edit	ProtectedRange.requestingUserCanEdit (boolean)	True if the user who requested this protected range can edit the protected area. This field is read-only.
Spreadsheet.sheets.protectedRanges.warningOnly	api_schema_field	Warning Only	ProtectedRange.warningOnly (boolean)	True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true,…
Spreadsheet.sheets.protectedRanges.description	api_schema_field	Description	ProtectedRange.description (string)	The description of this protected range.
Spreadsheet.sheets.rowGroups	api_schema_field	Row Groups	Sheet.rowGroups (array)	All row groups on this sheet, ordered by increasing range start index, then by group depth.
Spreadsheet.sheets.rowGroups.depth	api_schema_field	Depth	DimensionGroup.depth (integer)	The depth of the group, representing how many groups have a range that wholly contains the range of this group.
Spreadsheet.sheets.rowGroups.collapsed	api_schema_field	Collapsed	DimensionGroup.collapsed (boolean)	This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change…
Spreadsheet.sheets.rowGroups.range	api_schema_field	Range	DimensionGroup.range (object)	The range over which this group exists.
Spreadsheet.sheets.rowGroups.range.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Spreadsheet.sheets.rowGroups.range.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Spreadsheet.sheets.rowGroups.range.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Spreadsheet.sheets.rowGroups.range.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Spreadsheet.sheets.developerMetadata	api_schema_field	Developer Metadata	Sheet.developerMetadata (array)	The developer metadata associated with a sheet.
Spreadsheet.sheets.developerMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
Spreadsheet.sheets.developerMetadata.location.locationType	api_schema_field	Location Type	DeveloperMetadataLocation.locationType (string)	The type of location this object represents. This field is read-only.
Spreadsheet.sheets.developerMetadata.location.sheetId	api_schema_field	Sheet Id	DeveloperMetadataLocation.sheetId (integer)	The ID of the sheet when metadata is associated with an entire sheet.
Spreadsheet.sheets.developerMetadata.location.dimensionRange	api_schema_field	Dimension Range	DeveloperMetadataLocation.dimensionRange (object)	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
Spreadsheet.sheets.developerMetadata.location.spreadsheet	api_schema_field	Spreadsheet	DeveloperMetadataLocation.spreadsheet (boolean)	True when metadata is associated with an entire spreadsheet.
Spreadsheet.sheets.developerMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
Spreadsheet.sheets.developerMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
Spreadsheet.sheets.developerMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
Spreadsheet.sheets.developerMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
Spreadsheet.sheets.tables	api_schema_field	Tables	Sheet.tables (array)	The tables on this sheet.
Spreadsheet.sheets.tables.columnProperties	api_schema_field	Column Properties	Table.columnProperties (array)	The table column properties.
Spreadsheet.sheets.tables.columnProperties.columnIndex	api_schema_field	Column Index	TableColumnProperties.columnIndex (integer)	The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.
Spreadsheet.sheets.tables.columnProperties.dataValidationRule	api_schema_field	Data Validation Rule	TableColumnProperties.dataValidationRule (object)	The column data validation rule. Only set for dropdown column type.
Spreadsheet.sheets.tables.columnProperties.columnName	schema_pii_or_identity_field	Column Name	TableColumnProperties.columnName (string)	The column name.
Spreadsheet.sheets.tables.columnProperties.columnType	api_schema_field	Column Type	TableColumnProperties.columnType (string)	The column type.
Spreadsheet.sheets.tables.rowsProperties	api_schema_field	Rows Properties	Table.rowsProperties (object)	The table rows properties.
Spreadsheet.sheets.tables.rowsProperties.footerColorStyle	api_schema_field	Footer Color Style	TableRowsProperties.footerColorStyle (object)	The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have…
Spreadsheet.sheets.tables.rowsProperties.headerColorStyle	api_schema_field	Header Color Style	TableRowsProperties.headerColorStyle (object)	The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color.
Spreadsheet.sheets.tables.rowsProperties.firstBandColorStyle	api_schema_field	First Band Color Style	TableRowsProperties.firstBandColorStyle (object)	The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color.
Spreadsheet.sheets.tables.rowsProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	TableRowsProperties.secondBandColorStyle (object)	The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color.
Spreadsheet.sheets.tables.tableId	api_schema_field	Table Id	Table.tableId (string)	The id of the table.
Spreadsheet.sheets.tables.range	api_schema_field	Range	Table.range (object)	The table range.
Spreadsheet.sheets.tables.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.tables.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.tables.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.tables.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.tables.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.tables.name	schema_pii_or_identity_field	Name	Table.name (string)	The table name. This is unique to all tables in the same spreadsheet.
Spreadsheet.sheets.data	api_schema_field	Data	Sheet.data (array)	Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `…
Spreadsheet.sheets.data.startColumn	api_schema_field	Start Column	GridData.startColumn (integer)	The first column this GridData refers to, zero-based.
Spreadsheet.sheets.data.rowData	api_schema_field	Row Data	GridData.rowData (array)	The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.
Spreadsheet.sheets.data.rowData.values	api_schema_field	Values	RowData.values (array)	The values in the row, one per column.
Spreadsheet.sheets.data.rowMetadata	api_schema_field	Row Metadata	GridData.rowMetadata (array)	Metadata about the requested rows in the grid, starting with the row in start_row.
Spreadsheet.sheets.data.rowMetadata.pixelSize	api_schema_field	Pixel Size	DimensionProperties.pixelSize (integer)	The height (if a row) or width (if a column) of the dimension in pixels.
Spreadsheet.sheets.data.rowMetadata.developerMetadata	api_schema_field	Developer Metadata	DimensionProperties.developerMetadata (array)	The developer metadata associated with a single row or column.
Spreadsheet.sheets.data.rowMetadata.hiddenByUser	api_schema_field	Hidden By User	DimensionProperties.hiddenByUser (boolean)	True if this dimension is explicitly hidden.
Spreadsheet.sheets.data.rowMetadata.dataSourceColumnReference	api_schema_field	Data Source Column Reference	DimensionProperties.dataSourceColumnReference (object)	Output only. If set, this is a column in a data source sheet.
Spreadsheet.sheets.data.rowMetadata.hiddenByFilter	api_schema_field	Hidden By Filter	DimensionProperties.hiddenByFilter (boolean)	True if this dimension is being filtered. This field is read-only.
Spreadsheet.sheets.data.startRow	api_schema_field	Start Row	GridData.startRow (integer)	The first row this GridData refers to, zero-based.
Spreadsheet.sheets.data.columnMetadata	api_schema_field	Column Metadata	GridData.columnMetadata (array)	Metadata about the requested columns in the grid, starting with the column in start_column.
Spreadsheet.sheets.data.columnMetadata.pixelSize	api_schema_field	Pixel Size	DimensionProperties.pixelSize (integer)	The height (if a row) or width (if a column) of the dimension in pixels.
Spreadsheet.sheets.data.columnMetadata.developerMetadata	api_schema_field	Developer Metadata	DimensionProperties.developerMetadata (array)	The developer metadata associated with a single row or column.
Spreadsheet.sheets.data.columnMetadata.hiddenByUser	api_schema_field	Hidden By User	DimensionProperties.hiddenByUser (boolean)	True if this dimension is explicitly hidden.
Spreadsheet.sheets.data.columnMetadata.dataSourceColumnReference	api_schema_field	Data Source Column Reference	DimensionProperties.dataSourceColumnReference (object)	Output only. If set, this is a column in a data source sheet.
Spreadsheet.sheets.data.columnMetadata.hiddenByFilter	api_schema_field	Hidden By Filter	DimensionProperties.hiddenByFilter (boolean)	True if this dimension is being filtered. This field is read-only.
Spreadsheet.sheets.filterViews	api_schema_field	Filter Views	Sheet.filterViews (array)	The filter views in this sheet.
Spreadsheet.sheets.filterViews.sortSpecs	api_schema_field	Sort Specs	FilterView.sortSpecs (array)	The sort order per column. Later specifications are used when values are equal in the earlier specifications.
Spreadsheet.sheets.filterViews.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
Spreadsheet.sheets.filterViews.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
Spreadsheet.sheets.filterViews.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
Spreadsheet.sheets.filterViews.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
Spreadsheet.sheets.filterViews.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
Spreadsheet.sheets.filterViews.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
Spreadsheet.sheets.filterViews.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
Spreadsheet.sheets.filterViews.filterViewId	api_schema_field	Filter View Id	FilterView.filterViewId (integer)	The ID of the filter view.
Spreadsheet.sheets.filterViews.namedRangeId	schema_pii_or_identity_field	Named Range Id	FilterView.namedRangeId (string)	The named range this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.
Spreadsheet.sheets.filterViews.filterSpecs	api_schema_field	Filter Specs	FilterView.filterSpecs (array)	The filter criteria for showing or hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
Spreadsheet.sheets.filterViews.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
Spreadsheet.sheets.filterViews.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
Spreadsheet.sheets.filterViews.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
Spreadsheet.sheets.filterViews.range	api_schema_field	Range	FilterView.range (object)	The range this filter view covers. When writing, only one of range, named_range_id, or table_id may be set.
Spreadsheet.sheets.filterViews.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.filterViews.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.filterViews.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.filterViews.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.filterViews.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.filterViews.tableId	api_schema_field	Table Id	FilterView.tableId (string)	The table this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.
Spreadsheet.sheets.filterViews.criteria	api_schema_field	Criteria	FilterView.criteria (object)	The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.
Spreadsheet.sheets.filterViews.title	api_schema_field	Title	FilterView.title (string)	The name of the filter view.
Spreadsheet.sheets.bandedRanges	api_schema_field	Banded Ranges	Sheet.bandedRanges (array)	The banded (alternating colors) ranges on this sheet.
Spreadsheet.sheets.bandedRanges.bandedRangeId	api_schema_field	Banded Range Id	BandedRange.bandedRangeId (integer)	The ID of the banded range. If unset, refer to banded_range_reference.
Spreadsheet.sheets.bandedRanges.bandedRangeReference	api_schema_field	Banded Range Reference	BandedRange.bandedRangeReference (string)	Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.
Spreadsheet.sheets.bandedRanges.rowProperties	api_schema_field	Row Properties	BandedRange.rowProperties (object)	Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of row_properties or column_properties must be specified.
Spreadsheet.sheets.bandedRanges.rowProperties.headerColor	api_schema_field	Header Color	BandingProperties.headerColor (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Spreadsheet.sheets.bandedRanges.rowProperties.headerColorStyle	api_schema_field	Header Color Style	BandingProperties.headerColorStyle (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Spreadsheet.sheets.bandedRanges.rowProperties.firstBandColorStyle	api_schema_field	First Band Color Style	BandingProperties.firstBandColorStyle (object)	The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.rowProperties.secondBandColor	api_schema_field	Second Band Color	BandingProperties.secondBandColor (object)	The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
Spreadsheet.sheets.bandedRanges.rowProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	BandingProperties.secondBandColorStyle (object)	The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.rowProperties.firstBandColor	api_schema_field	First Band Color	BandingProperties.firstBandColor (object)	The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
Spreadsheet.sheets.bandedRanges.rowProperties.footerColor	api_schema_field	Footer Color	BandingProperties.footerColor (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.
Spreadsheet.sheets.bandedRanges.rowProperties.footerColorStyle	api_schema_field	Footer Color Style	BandingProperties.footerColorStyle (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.columnProperties	api_schema_field	Column Properties	BandedRange.columnProperties (object)	Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified.
Spreadsheet.sheets.bandedRanges.columnProperties.headerColor	api_schema_field	Header Color	BandingProperties.headerColor (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Spreadsheet.sheets.bandedRanges.columnProperties.headerColorStyle	api_schema_field	Header Color Style	BandingProperties.headerColorStyle (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Spreadsheet.sheets.bandedRanges.columnProperties.firstBandColorStyle	api_schema_field	First Band Color Style	BandingProperties.firstBandColorStyle (object)	The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.columnProperties.secondBandColor	api_schema_field	Second Band Color	BandingProperties.secondBandColor (object)	The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
Spreadsheet.sheets.bandedRanges.columnProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	BandingProperties.secondBandColorStyle (object)	The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.columnProperties.firstBandColor	api_schema_field	First Band Color	BandingProperties.firstBandColor (object)	The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
Spreadsheet.sheets.bandedRanges.columnProperties.footerColor	api_schema_field	Footer Color	BandingProperties.footerColor (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.
Spreadsheet.sheets.bandedRanges.columnProperties.footerColorStyle	api_schema_field	Footer Color Style	BandingProperties.footerColorStyle (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
Spreadsheet.sheets.bandedRanges.range	api_schema_field	Range	BandedRange.range (object)	The range over which these properties are applied.
Spreadsheet.sheets.bandedRanges.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.bandedRanges.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.bandedRanges.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.bandedRanges.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.bandedRanges.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.conditionalFormats	api_schema_field	Conditional Formats	Sheet.conditionalFormats (array)	The conditional format rules in this sheet.
Spreadsheet.sheets.conditionalFormats.ranges	api_schema_field	Ranges	ConditionalFormatRule.ranges (array)	The ranges that are formatted if the condition is true. All the ranges must be on the same grid.
Spreadsheet.sheets.conditionalFormats.ranges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.conditionalFormats.ranges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.conditionalFormats.ranges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.conditionalFormats.ranges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.conditionalFormats.ranges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.conditionalFormats.gradientRule	api_schema_field	Gradient Rule	ConditionalFormatRule.gradientRule (object)	The formatting will vary based on the gradients in the rule.
Spreadsheet.sheets.conditionalFormats.gradientRule.minpoint	api_schema_field	Minpoint	GradientRule.minpoint (object)	The starting interpolation point.
Spreadsheet.sheets.conditionalFormats.gradientRule.midpoint	api_schema_field	Midpoint	GradientRule.midpoint (object)	An optional midway interpolation point.
Spreadsheet.sheets.conditionalFormats.gradientRule.maxpoint	api_schema_field	Maxpoint	GradientRule.maxpoint (object)	The final interpolation point.
Spreadsheet.sheets.conditionalFormats.booleanRule	api_schema_field	Boolean Rule	ConditionalFormatRule.booleanRule (object)	The formatting is either "on" or "off" according to the rule.
Spreadsheet.sheets.conditionalFormats.booleanRule.condition	api_schema_field	Condition	BooleanRule.condition (object)	The condition of the rule. If the condition evaluates to true, the format is applied.
Spreadsheet.sheets.conditionalFormats.booleanRule.format	api_schema_field	Format	BooleanRule.format (object)	The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color and, background color.
Spreadsheet.sheets.merges	api_schema_field	Merges	Sheet.merges (array)	The ranges that are merged together.
Spreadsheet.sheets.merges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.sheets.merges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.merges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.merges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.sheets.merges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.spreadsheetUrl	api_schema_field	Spreadsheet Url	Spreadsheet.spreadsheetUrl (string)	The url of the spreadsheet. This field is read-only.
Spreadsheet.developerMetadata	api_schema_field	Developer Metadata	Spreadsheet.developerMetadata (array)	The developer metadata associated with a spreadsheet.
Spreadsheet.developerMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
Spreadsheet.developerMetadata.location.locationType	api_schema_field	Location Type	DeveloperMetadataLocation.locationType (string)	The type of location this object represents. This field is read-only.
Spreadsheet.developerMetadata.location.sheetId	api_schema_field	Sheet Id	DeveloperMetadataLocation.sheetId (integer)	The ID of the sheet when metadata is associated with an entire sheet.
Spreadsheet.developerMetadata.location.dimensionRange	api_schema_field	Dimension Range	DeveloperMetadataLocation.dimensionRange (object)	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
Spreadsheet.developerMetadata.location.dimensionRange.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Spreadsheet.developerMetadata.location.dimensionRange.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Spreadsheet.developerMetadata.location.dimensionRange.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Spreadsheet.developerMetadata.location.dimensionRange.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Spreadsheet.developerMetadata.location.spreadsheet	api_schema_field	Spreadsheet	DeveloperMetadataLocation.spreadsheet (boolean)	True when metadata is associated with an entire spreadsheet.
Spreadsheet.developerMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
Spreadsheet.developerMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
Spreadsheet.developerMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
Spreadsheet.developerMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
Spreadsheet.namedRanges	schema_pii_or_identity_field	Named Ranges	Spreadsheet.namedRanges (array)	The named ranges defined in a spreadsheet.
Spreadsheet.namedRanges.namedRangeId	schema_pii_or_identity_field	Named Range Id	NamedRange.namedRangeId (string)	The ID of the named range.
Spreadsheet.namedRanges.name	schema_pii_or_identity_field	Name	NamedRange.name (string)	The name of the named range.
Spreadsheet.namedRanges.range	schema_pii_or_identity_field	Range	NamedRange.range (object)	The range this represents.
Spreadsheet.namedRanges.range.sheetId	schema_pii_or_identity_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Spreadsheet.namedRanges.range.endColumnIndex	schema_pii_or_identity_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Spreadsheet.namedRanges.range.startRowIndex	schema_pii_or_identity_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Spreadsheet.namedRanges.range.endRowIndex	schema_pii_or_identity_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Spreadsheet.namedRanges.range.startColumnIndex	schema_pii_or_identity_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Spreadsheet.spreadsheetId	api_schema_field	Spreadsheet Id	Spreadsheet.spreadsheetId (string)	The ID of the spreadsheet. This field is read-only.
Spreadsheet.properties	api_schema_field	Properties	Spreadsheet.properties (object)	Overall properties of a spreadsheet.
Spreadsheet.properties.autoRecalc	api_schema_field	Auto Recalc	SpreadsheetProperties.autoRecalc (string)	The amount of time to wait before volatile functions are recalculated.
Spreadsheet.properties.spreadsheetTheme	api_schema_field	Spreadsheet Theme	SpreadsheetProperties.spreadsheetTheme (object)	Theme applied to the spreadsheet.
Spreadsheet.properties.spreadsheetTheme.themeColors	api_schema_field	Theme Colors	SpreadsheetTheme.themeColors (array)	The spreadsheet theme color pairs. To update you must provide all theme color pairs.
Spreadsheet.properties.spreadsheetTheme.themeColors.colorType	api_schema_field	Color Type	ThemeColorPair.colorType (string)	The type of the spreadsheet theme color.
Spreadsheet.properties.spreadsheetTheme.themeColors.color	api_schema_field	Color	ThemeColorPair.color (object)	The concrete color corresponding to the theme color type.
Spreadsheet.properties.spreadsheetTheme.primaryFontFamily	api_schema_field	Primary Font Family	SpreadsheetTheme.primaryFontFamily (string)	Name of the primary font family.
Spreadsheet.properties.locale	api_schema_field	Locale	SpreadsheetProperties.locale (string)	The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when…
Spreadsheet.properties.timeZone	api_schema_field	Time Zone	SpreadsheetProperties.timeZone (string)	The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.
Spreadsheet.properties.importFunctionsExternalUrlAccessAllowed	api_schema_field	Import Functions External Url Access Allowed	SpreadsheetProperties.importFunctionsExternalUrlAccessAllowed (boolean)	Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=ur…
Spreadsheet.properties.title	api_schema_field	Title	SpreadsheetProperties.title (string)	The title of the spreadsheet.
Spreadsheet.properties.defaultFormat	api_schema_field	Default Format	SpreadsheetProperties.defaultFormat (object)	The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only.
Spreadsheet.properties.defaultFormat.numberFormat	api_schema_field	Number Format	CellFormat.numberFormat (object)	A format describing how number values should be represented to the user.
Spreadsheet.properties.defaultFormat.numberFormat.type	api_schema_field	Type	NumberFormat.type (string)	The type of the number format. When writing, this field must be set.
Spreadsheet.properties.defaultFormat.numberFormat.pattern	api_schema_field	Pattern	NumberFormat.pattern (string)	Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for mo…
Spreadsheet.properties.defaultFormat.textFormat	api_schema_field	Text Format	CellFormat.textFormat (object)	The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
Spreadsheet.properties.defaultFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
Spreadsheet.properties.defaultFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
Spreadsheet.properties.defaultFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
Spreadsheet.properties.defaultFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
Spreadsheet.properties.defaultFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
Spreadsheet.properties.defaultFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
Spreadsheet.properties.defaultFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
Spreadsheet.properties.defaultFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
Spreadsheet.properties.defaultFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
Spreadsheet.properties.defaultFormat.textRotation	api_schema_field	Text Rotation	CellFormat.textRotation (object)	The rotation applied to text in the cell.
Spreadsheet.properties.defaultFormat.textRotation.angle	api_schema_field	Angle	TextRotation.angle (integer)	The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counte…
Spreadsheet.properties.defaultFormat.textRotation.vertical	api_schema_field	Vertical	TextRotation.vertical (boolean)	If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: \| V \| \| e \| \| r \| \| t \| \| i \| \| c \| \| a \| \| l \|
Spreadsheet.properties.defaultFormat.verticalAlignment	api_schema_field	Vertical Alignment	CellFormat.verticalAlignment (string)	The vertical alignment of the value in the cell.
Spreadsheet.properties.defaultFormat.backgroundColorStyle	api_schema_field	Background Color Style	CellFormat.backgroundColorStyle (object)	The background color of the cell. If background_color is also set, this field takes precedence.
Spreadsheet.properties.defaultFormat.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Spreadsheet.properties.defaultFormat.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Spreadsheet.properties.defaultFormat.textDirection	api_schema_field	Text Direction	CellFormat.textDirection (string)	The direction of the text in the cell.
Spreadsheet.properties.defaultFormat.wrapStrategy	api_schema_field	Wrap Strategy	CellFormat.wrapStrategy (string)	The wrap strategy for the value in the cell.
Spreadsheet.properties.defaultFormat.backgroundColor	api_schema_field	Background Color	CellFormat.backgroundColor (object)	The background color of the cell. Deprecated: Use background_color_style.
Spreadsheet.properties.defaultFormat.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Spreadsheet.properties.defaultFormat.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Spreadsheet.properties.defaultFormat.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Spreadsheet.properties.defaultFormat.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Spreadsheet.properties.defaultFormat.borders	api_schema_field	Borders	CellFormat.borders (object)	The borders of the cell.
Spreadsheet.properties.defaultFormat.borders.top	api_schema_field	Top	Borders.top (object)	The top border of the cell.
Spreadsheet.properties.defaultFormat.borders.bottom	api_schema_field	Bottom	Borders.bottom (object)	The bottom border of the cell.
Spreadsheet.properties.defaultFormat.borders.right	api_schema_field	Right	Borders.right (object)	The right border of the cell.
Spreadsheet.properties.defaultFormat.borders.left	api_schema_field	Left	Borders.left (object)	The left border of the cell.
Spreadsheet.properties.defaultFormat.padding	api_schema_field	Padding	CellFormat.padding (object)	The padding of the cell.
Spreadsheet.properties.defaultFormat.padding.left	api_schema_field	Left	Padding.left (integer)	The left padding of the cell.
Spreadsheet.properties.defaultFormat.padding.right	api_schema_field	Right	Padding.right (integer)	The right padding of the cell.
Spreadsheet.properties.defaultFormat.padding.top	api_schema_field	Top	Padding.top (integer)	The top padding of the cell.
Spreadsheet.properties.defaultFormat.padding.bottom	api_schema_field	Bottom	Padding.bottom (integer)	The bottom padding of the cell.
Spreadsheet.properties.defaultFormat.hyperlinkDisplayType	api_schema_field	Hyperlink Display Type	CellFormat.hyperlinkDisplayType (string)	If one exists, how a hyperlink should be displayed in the cell.
Spreadsheet.properties.defaultFormat.horizontalAlignment	api_schema_field	Horizontal Alignment	CellFormat.horizontalAlignment (string)	The horizontal alignment of the value in the cell.
Spreadsheet.properties.iterativeCalculationSettings	api_schema_field	Iterative Calculation Settings	SpreadsheetProperties.iterativeCalculationSettings (object)	Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors.
Spreadsheet.properties.iterativeCalculationSettings.convergenceThreshold	api_schema_field	Convergence Threshold	IterativeCalculationSettings.convergenceThreshold (number)	When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.
Spreadsheet.properties.iterativeCalculationSettings.maxIterations	api_schema_field	Max Iterations	IterativeCalculationSettings.maxIterations (integer)	When iterative calculation is enabled, the maximum number of calculation rounds to perform.
Spreadsheet.dataSourceSchedules	api_schema_field	Data Source Schedules	Spreadsheet.dataSourceSchedules (array)	Output only. A list of data source refresh schedules.
Spreadsheet.dataSourceSchedules.dailySchedule	api_schema_field	Daily Schedule	DataSourceRefreshSchedule.dailySchedule (object)	Daily refresh schedule.
Spreadsheet.dataSourceSchedules.dailySchedule.startTime	api_schema_field	Start Time	DataSourceRefreshDailySchedule.startTime (object)	The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor.
Spreadsheet.dataSourceSchedules.dailySchedule.startTime.seconds	api_schema_field	Seconds	TimeOfDay.seconds (integer)	Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
Spreadsheet.dataSourceSchedules.dailySchedule.startTime.minutes	api_schema_field	Minutes	TimeOfDay.minutes (integer)	Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
Spreadsheet.dataSourceSchedules.dailySchedule.startTime.nanos	api_schema_field	Nanos	TimeOfDay.nanos (integer)	Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
Spreadsheet.dataSourceSchedules.dailySchedule.startTime.hours	api_schema_field	Hours	TimeOfDay.hours (integer)	Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Spreadsheet.dataSourceSchedules.nextRun	api_schema_field	Next Run	DataSourceRefreshSchedule.nextRun (object)	Output only. The time interval of the next run.
Spreadsheet.dataSourceSchedules.nextRun.startTime	api_schema_field	Start Time	Interval.startTime (string)	Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
Spreadsheet.dataSourceSchedules.nextRun.endTime	api_schema_field	End Time	Interval.endTime (string)	Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
Spreadsheet.dataSourceSchedules.refreshScope	api_schema_field	Refresh Scope	DataSourceRefreshSchedule.refreshScope (string)	The scope of the refresh. Must be ALL_DATA_SOURCES.
Spreadsheet.dataSourceSchedules.weeklySchedule	api_schema_field	Weekly Schedule	DataSourceRefreshSchedule.weeklySchedule (object)	Weekly refresh schedule.
Spreadsheet.dataSourceSchedules.weeklySchedule.daysOfWeek	api_schema_field	Days Of Week	DataSourceRefreshWeeklySchedule.daysOfWeek (array)	Days of the week to refresh. At least one day must be specified.
Spreadsheet.dataSourceSchedules.weeklySchedule.startTime	api_schema_field	Start Time	DataSourceRefreshWeeklySchedule.startTime (object)	The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor.
Spreadsheet.dataSourceSchedules.weeklySchedule.startTime.seconds	api_schema_field	Seconds	TimeOfDay.seconds (integer)	Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
Spreadsheet.dataSourceSchedules.weeklySchedule.startTime.minutes	api_schema_field	Minutes	TimeOfDay.minutes (integer)	Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
Spreadsheet.dataSourceSchedules.weeklySchedule.startTime.nanos	api_schema_field	Nanos	TimeOfDay.nanos (integer)	Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
Spreadsheet.dataSourceSchedules.weeklySchedule.startTime.hours	api_schema_field	Hours	TimeOfDay.hours (integer)	Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Spreadsheet.dataSourceSchedules.enabled	api_schema_field	Enabled	DataSourceRefreshSchedule.enabled (boolean)	True if the refresh schedule is enabled, or false otherwise.
Spreadsheet.dataSourceSchedules.monthlySchedule	api_schema_field	Monthly Schedule	DataSourceRefreshSchedule.monthlySchedule (object)	Monthly refresh schedule.
Spreadsheet.dataSourceSchedules.monthlySchedule.startTime	api_schema_field	Start Time	DataSourceRefreshMonthlySchedule.startTime (object)	The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor.
Spreadsheet.dataSourceSchedules.monthlySchedule.startTime.seconds	api_schema_field	Seconds	TimeOfDay.seconds (integer)	Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
Spreadsheet.dataSourceSchedules.monthlySchedule.startTime.minutes	api_schema_field	Minutes	TimeOfDay.minutes (integer)	Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
Spreadsheet.dataSourceSchedules.monthlySchedule.startTime.nanos	api_schema_field	Nanos	TimeOfDay.nanos (integer)	Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
Spreadsheet.dataSourceSchedules.monthlySchedule.startTime.hours	api_schema_field	Hours	TimeOfDay.hours (integer)	Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Spreadsheet.dataSourceSchedules.monthlySchedule.daysOfMonth	api_schema_field	Days Of Month	DataSourceRefreshMonthlySchedule.daysOfMonth (array)	Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.
SpreadsheetProperties.autoRecalc	api_schema_field	Auto Recalc	SpreadsheetProperties.autoRecalc (string)	The amount of time to wait before volatile functions are recalculated.
SpreadsheetProperties.spreadsheetTheme	api_schema_field	Spreadsheet Theme	SpreadsheetProperties.spreadsheetTheme (object)	Theme applied to the spreadsheet.
SpreadsheetProperties.spreadsheetTheme.themeColors	api_schema_field	Theme Colors	SpreadsheetTheme.themeColors (array)	The spreadsheet theme color pairs. To update you must provide all theme color pairs.
SpreadsheetProperties.spreadsheetTheme.themeColors.colorType	api_schema_field	Color Type	ThemeColorPair.colorType (string)	The type of the spreadsheet theme color.
SpreadsheetProperties.spreadsheetTheme.themeColors.color	api_schema_field	Color	ThemeColorPair.color (object)	The concrete color corresponding to the theme color type.
SpreadsheetProperties.spreadsheetTheme.themeColors.color.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
SpreadsheetProperties.spreadsheetTheme.themeColors.color.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
SpreadsheetProperties.spreadsheetTheme.primaryFontFamily	api_schema_field	Primary Font Family	SpreadsheetTheme.primaryFontFamily (string)	Name of the primary font family.
SpreadsheetProperties.locale	api_schema_field	Locale	SpreadsheetProperties.locale (string)	The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when…
SpreadsheetProperties.timeZone	api_schema_field	Time Zone	SpreadsheetProperties.timeZone (string)	The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.
SpreadsheetProperties.importFunctionsExternalUrlAccessAllowed	api_schema_field	Import Functions External Url Access Allowed	SpreadsheetProperties.importFunctionsExternalUrlAccessAllowed (boolean)	Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=ur…
SpreadsheetProperties.title	api_schema_field	Title	SpreadsheetProperties.title (string)	The title of the spreadsheet.
SpreadsheetProperties.defaultFormat	api_schema_field	Default Format	SpreadsheetProperties.defaultFormat (object)	The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only.
SpreadsheetProperties.defaultFormat.numberFormat	api_schema_field	Number Format	CellFormat.numberFormat (object)	A format describing how number values should be represented to the user.
SpreadsheetProperties.defaultFormat.numberFormat.type	api_schema_field	Type	NumberFormat.type (string)	The type of the number format. When writing, this field must be set.
SpreadsheetProperties.defaultFormat.numberFormat.pattern	api_schema_field	Pattern	NumberFormat.pattern (string)	Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for mo…
SpreadsheetProperties.defaultFormat.textFormat	api_schema_field	Text Format	CellFormat.textFormat (object)	The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
SpreadsheetProperties.defaultFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.textFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
SpreadsheetProperties.defaultFormat.textFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
SpreadsheetProperties.defaultFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
SpreadsheetProperties.defaultFormat.textFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.textFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.textFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
SpreadsheetProperties.defaultFormat.textFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
SpreadsheetProperties.defaultFormat.textFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
SpreadsheetProperties.defaultFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
SpreadsheetProperties.defaultFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
SpreadsheetProperties.defaultFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
SpreadsheetProperties.defaultFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
SpreadsheetProperties.defaultFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
SpreadsheetProperties.defaultFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
SpreadsheetProperties.defaultFormat.textRotation	api_schema_field	Text Rotation	CellFormat.textRotation (object)	The rotation applied to text in the cell.
SpreadsheetProperties.defaultFormat.textRotation.angle	api_schema_field	Angle	TextRotation.angle (integer)	The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counte…
SpreadsheetProperties.defaultFormat.textRotation.vertical	api_schema_field	Vertical	TextRotation.vertical (boolean)	If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: \| V \| \| e \| \| r \| \| t \| \| i \| \| c \| \| a \| \| l \|
SpreadsheetProperties.defaultFormat.verticalAlignment	api_schema_field	Vertical Alignment	CellFormat.verticalAlignment (string)	The vertical alignment of the value in the cell.
SpreadsheetProperties.defaultFormat.backgroundColorStyle	api_schema_field	Background Color Style	CellFormat.backgroundColorStyle (object)	The background color of the cell. If background_color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
SpreadsheetProperties.defaultFormat.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
SpreadsheetProperties.defaultFormat.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
SpreadsheetProperties.defaultFormat.textDirection	api_schema_field	Text Direction	CellFormat.textDirection (string)	The direction of the text in the cell.
SpreadsheetProperties.defaultFormat.wrapStrategy	api_schema_field	Wrap Strategy	CellFormat.wrapStrategy (string)	The wrap strategy for the value in the cell.
SpreadsheetProperties.defaultFormat.backgroundColor	api_schema_field	Background Color	CellFormat.backgroundColor (object)	The background color of the cell. Deprecated: Use background_color_style.
SpreadsheetProperties.defaultFormat.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
SpreadsheetProperties.defaultFormat.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
SpreadsheetProperties.defaultFormat.borders	api_schema_field	Borders	CellFormat.borders (object)	The borders of the cell.
SpreadsheetProperties.defaultFormat.borders.top	api_schema_field	Top	Borders.top (object)	The top border of the cell.
SpreadsheetProperties.defaultFormat.borders.top.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
SpreadsheetProperties.defaultFormat.borders.top.style	api_schema_field	Style	Border.style (string)	The style of the border.
SpreadsheetProperties.defaultFormat.borders.top.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
SpreadsheetProperties.defaultFormat.borders.top.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.borders.bottom	api_schema_field	Bottom	Borders.bottom (object)	The bottom border of the cell.
SpreadsheetProperties.defaultFormat.borders.bottom.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
SpreadsheetProperties.defaultFormat.borders.bottom.style	api_schema_field	Style	Border.style (string)	The style of the border.
SpreadsheetProperties.defaultFormat.borders.bottom.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
SpreadsheetProperties.defaultFormat.borders.bottom.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.borders.right	api_schema_field	Right	Borders.right (object)	The right border of the cell.
SpreadsheetProperties.defaultFormat.borders.right.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
SpreadsheetProperties.defaultFormat.borders.right.style	api_schema_field	Style	Border.style (string)	The style of the border.
SpreadsheetProperties.defaultFormat.borders.right.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
SpreadsheetProperties.defaultFormat.borders.right.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.borders.left	api_schema_field	Left	Borders.left (object)	The left border of the cell.
SpreadsheetProperties.defaultFormat.borders.left.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
SpreadsheetProperties.defaultFormat.borders.left.style	api_schema_field	Style	Border.style (string)	The style of the border.
SpreadsheetProperties.defaultFormat.borders.left.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
SpreadsheetProperties.defaultFormat.borders.left.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
SpreadsheetProperties.defaultFormat.padding	api_schema_field	Padding	CellFormat.padding (object)	The padding of the cell.
SpreadsheetProperties.defaultFormat.padding.left	api_schema_field	Left	Padding.left (integer)	The left padding of the cell.
SpreadsheetProperties.defaultFormat.padding.right	api_schema_field	Right	Padding.right (integer)	The right padding of the cell.
SpreadsheetProperties.defaultFormat.padding.top	api_schema_field	Top	Padding.top (integer)	The top padding of the cell.
SpreadsheetProperties.defaultFormat.padding.bottom	api_schema_field	Bottom	Padding.bottom (integer)	The bottom padding of the cell.
SpreadsheetProperties.defaultFormat.hyperlinkDisplayType	api_schema_field	Hyperlink Display Type	CellFormat.hyperlinkDisplayType (string)	If one exists, how a hyperlink should be displayed in the cell.
SpreadsheetProperties.defaultFormat.horizontalAlignment	api_schema_field	Horizontal Alignment	CellFormat.horizontalAlignment (string)	The horizontal alignment of the value in the cell.
SpreadsheetProperties.iterativeCalculationSettings	api_schema_field	Iterative Calculation Settings	SpreadsheetProperties.iterativeCalculationSettings (object)	Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors.
SpreadsheetProperties.iterativeCalculationSettings.convergenceThreshold	api_schema_field	Convergence Threshold	IterativeCalculationSettings.convergenceThreshold (number)	When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.
SpreadsheetProperties.iterativeCalculationSettings.maxIterations	api_schema_field	Max Iterations	IterativeCalculationSettings.maxIterations (integer)	When iterative calculation is enabled, the maximum number of calculation rounds to perform.
Sheet.basicFilter	api_schema_field	Basic Filter	Sheet.basicFilter (object)	The filter on this sheet, if any.
Sheet.basicFilter.sortSpecs	api_schema_field	Sort Specs	BasicFilter.sortSpecs (array)	The sort order per column. Later specifications are used when values are equal in the earlier specifications.
Sheet.basicFilter.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.basicFilter.sortSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.basicFilter.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
Sheet.basicFilter.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
Sheet.basicFilter.sortSpecs.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.basicFilter.sortSpecs.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.basicFilter.sortSpecs.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.basicFilter.sortSpecs.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.basicFilter.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
Sheet.basicFilter.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
Sheet.basicFilter.sortSpecs.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.basicFilter.sortSpecs.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.basicFilter.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
Sheet.basicFilter.sortSpecs.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.basicFilter.sortSpecs.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.basicFilter.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
Sheet.basicFilter.sortSpecs.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.basicFilter.sortSpecs.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.basicFilter.sortSpecs.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.basicFilter.sortSpecs.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.basicFilter.filterSpecs	api_schema_field	Filter Specs	BasicFilter.filterSpecs (array)	The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
Sheet.basicFilter.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.basicFilter.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.basicFilter.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
Sheet.basicFilter.filterSpecs.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
Sheet.basicFilter.filterSpecs.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
Sheet.basicFilter.filterSpecs.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
Sheet.basicFilter.filterSpecs.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
Sheet.basicFilter.filterSpecs.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
Sheet.basicFilter.filterSpecs.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
Sheet.basicFilter.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
Sheet.basicFilter.range	api_schema_field	Range	BasicFilter.range (object)	The range the filter covers.
Sheet.basicFilter.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.basicFilter.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.basicFilter.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.basicFilter.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.basicFilter.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.basicFilter.tableId	api_schema_field	Table Id	BasicFilter.tableId (string)	The table this filter is backed by, if any. When writing, only one of range or table_id may be set.
Sheet.basicFilter.criteria	api_schema_field	Criteria	BasicFilter.criteria (object)	The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.
Sheet.properties	api_schema_field	Properties	Sheet.properties (object)	The properties of the sheet.
Sheet.properties.title	api_schema_field	Title	SheetProperties.title (string)	The name of the sheet.
Sheet.properties.gridProperties	api_schema_field	Grid Properties	SheetProperties.gridProperties (object)	Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOUR…
Sheet.properties.gridProperties.frozenColumnCount	api_schema_field	Frozen Column Count	GridProperties.frozenColumnCount (integer)	The number of columns that are frozen in the grid.
Sheet.properties.gridProperties.hideGridlines	api_schema_field	Hide Gridlines	GridProperties.hideGridlines (boolean)	True if the grid isn't showing gridlines in the UI.
Sheet.properties.gridProperties.rowCount	api_schema_field	Row Count	GridProperties.rowCount (integer)	The number of rows in the grid.
Sheet.properties.gridProperties.columnCount	api_schema_field	Column Count	GridProperties.columnCount (integer)	The number of columns in the grid.
Sheet.properties.gridProperties.columnGroupControlAfter	api_schema_field	Column Group Control After	GridProperties.columnGroupControlAfter (boolean)	True if the column grouping control toggle is shown after the group.
Sheet.properties.gridProperties.frozenRowCount	api_schema_field	Frozen Row Count	GridProperties.frozenRowCount (integer)	The number of rows that are frozen in the grid.
Sheet.properties.gridProperties.rowGroupControlAfter	api_schema_field	Row Group Control After	GridProperties.rowGroupControlAfter (boolean)	True if the row grouping control toggle is shown after the group.
Sheet.properties.tabColor	api_schema_field	Tab Color	SheetProperties.tabColor (object)	The color of the tab in the UI. Deprecated: Use tab_color_style.
Sheet.properties.tabColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.properties.tabColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.properties.tabColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.properties.tabColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.properties.hidden	api_schema_field	Hidden	SheetProperties.hidden (boolean)	True if the sheet is hidden in the UI, false if it's visible.
Sheet.properties.sheetType	api_schema_field	Sheet Type	SheetProperties.sheetType (string)	The type of sheet. Defaults to GRID. This field cannot be changed once set.
Sheet.properties.dataSourceSheetProperties	api_schema_field	Data Source Sheet Properties	SheetProperties.dataSourceSheetProperties (object)	Output only. If present, the field contains DATA_SOURCE sheet specific properties.
Sheet.properties.dataSourceSheetProperties.dataSourceId	api_schema_field	Data Source Id	DataSourceSheetProperties.dataSourceId (string)	ID of the DataSource the sheet is connected to.
Sheet.properties.dataSourceSheetProperties.columns	api_schema_field	Columns	DataSourceSheetProperties.columns (array)	The columns displayed on the sheet, corresponding to the values in RowData.
Sheet.properties.dataSourceSheetProperties.columns.formula	api_schema_field	Formula	DataSourceColumn.formula (string)	The formula of the calculated column.
Sheet.properties.dataSourceSheetProperties.columns.reference	api_schema_field	Reference	DataSourceColumn.reference (object)	The column reference.
Sheet.properties.dataSourceSheetProperties.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceSheetProperties.dataExecutionStatus (object)	The data execution status.
Sheet.properties.dataSourceSheetProperties.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
Sheet.properties.dataSourceSheetProperties.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
Sheet.properties.dataSourceSheetProperties.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
Sheet.properties.dataSourceSheetProperties.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
Sheet.properties.index	api_schema_field	Index	SheetProperties.index (integer)	The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "befor…
Sheet.properties.sheetId	api_schema_field	Sheet Id	SheetProperties.sheetId (integer)	The ID of the sheet. Must be non-negative. This field cannot be changed once set.
Sheet.properties.rightToLeft	api_schema_field	Right To Left	SheetProperties.rightToLeft (boolean)	True if the sheet is an RTL sheet instead of an LTR sheet.
Sheet.properties.tabColorStyle	api_schema_field	Tab Color Style	SheetProperties.tabColorStyle (object)	The color of the tab in the UI. If tab_color is also set, this field takes precedence.
Sheet.properties.tabColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.properties.tabColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.properties.tabColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.properties.tabColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.properties.tabColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.properties.tabColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.columnGroups	api_schema_field	Column Groups	Sheet.columnGroups (array)	All column groups on this sheet, ordered by increasing range start index, then by group depth.
Sheet.columnGroups.depth	api_schema_field	Depth	DimensionGroup.depth (integer)	The depth of the group, representing how many groups have a range that wholly contains the range of this group.
Sheet.columnGroups.collapsed	api_schema_field	Collapsed	DimensionGroup.collapsed (boolean)	This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change…
Sheet.columnGroups.range	api_schema_field	Range	DimensionGroup.range (object)	The range over which this group exists.
Sheet.columnGroups.range.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Sheet.columnGroups.range.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Sheet.columnGroups.range.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Sheet.columnGroups.range.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Sheet.charts	api_schema_field	Charts	Sheet.charts (array)	The specifications of every chart on this sheet.
Sheet.charts.chartId	api_schema_field	Chart Id	EmbeddedChart.chartId (integer)	The ID of the chart.
Sheet.charts.spec	api_schema_field	Spec	EmbeddedChart.spec (object)	The specification of the chart.
Sheet.charts.spec.hiddenDimensionStrategy	api_schema_field	Hidden Dimension Strategy	ChartSpec.hiddenDimensionStrategy (string)	Determines how the charts will use hidden rows or columns.
Sheet.charts.spec.orgChart	api_schema_field	Org Chart	ChartSpec.orgChart (object)	An org chart specification.
Sheet.charts.spec.orgChart.nodeSize	api_schema_field	Node Size	OrgChartSpec.nodeSize (string)	The size of the org chart nodes.
Sheet.charts.spec.orgChart.selectedNodeColorStyle	api_schema_field	Selected Node Color Style	OrgChartSpec.selectedNodeColorStyle (object)	The color of the selected org chart nodes. If selected_node_color is also set, this field takes precedence.
Sheet.charts.spec.orgChart.labels	api_schema_field	Labels	OrgChartSpec.labels (object)	The data containing the labels for all the nodes in the chart. Labels must be unique.
Sheet.charts.spec.orgChart.parentLabels	api_schema_field	Parent Labels	OrgChartSpec.parentLabels (object)	The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional.
Sheet.charts.spec.orgChart.nodeColor	api_schema_field	Node Color	OrgChartSpec.nodeColor (object)	The color of the org chart nodes. Deprecated: Use node_color_style.
Sheet.charts.spec.orgChart.nodeColorStyle	api_schema_field	Node Color Style	OrgChartSpec.nodeColorStyle (object)	The color of the org chart nodes. If node_color is also set, this field takes precedence.
Sheet.charts.spec.orgChart.selectedNodeColor	api_schema_field	Selected Node Color	OrgChartSpec.selectedNodeColor (object)	The color of the selected org chart nodes. Deprecated: Use selected_node_color_style.
Sheet.charts.spec.orgChart.tooltips	api_schema_field	Tooltips	OrgChartSpec.tooltips (object)	The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional.
Sheet.charts.spec.title	api_schema_field	Title	ChartSpec.title (string)	The title of the chart.
Sheet.charts.spec.titleTextFormat	api_schema_field	Title Text Format	ChartSpec.titleTextFormat (object)	The title text format. Strikethrough, underline, and link are not supported.
Sheet.charts.spec.titleTextFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
Sheet.charts.spec.titleTextFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
Sheet.charts.spec.titleTextFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
Sheet.charts.spec.titleTextFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
Sheet.charts.spec.titleTextFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
Sheet.charts.spec.titleTextFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
Sheet.charts.spec.titleTextFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
Sheet.charts.spec.titleTextFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
Sheet.charts.spec.titleTextFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
Sheet.charts.spec.maximized	api_schema_field	Maximized	ChartSpec.maximized (boolean)	True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
Sheet.charts.spec.dataSourceChartProperties	api_schema_field	Data Source Chart Properties	ChartSpec.dataSourceChartProperties (object)	If present, the field contains data source chart specific properties.
Sheet.charts.spec.dataSourceChartProperties.dataSourceId	api_schema_field	Data Source Id	DataSourceChartProperties.dataSourceId (string)	ID of the data source that the chart is associated with.
Sheet.charts.spec.dataSourceChartProperties.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceChartProperties.dataExecutionStatus (object)	Output only. The data execution status.
Sheet.charts.spec.backgroundColorStyle	api_schema_field	Background Color Style	ChartSpec.backgroundColorStyle (object)	The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
Sheet.charts.spec.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.charts.spec.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.charts.spec.filterSpecs	api_schema_field	Filter Specs	ChartSpec.filterSpecs (array)	The filters applied to the source data of the chart. Only supported for data source charts.
Sheet.charts.spec.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.charts.spec.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
Sheet.charts.spec.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
Sheet.charts.spec.bubbleChart	api_schema_field	Bubble Chart	ChartSpec.bubbleChart (object)	A bubble chart specification.
Sheet.charts.spec.bubbleChart.bubbleTextStyle	api_schema_field	Bubble Text Style	BubbleChartSpec.bubbleTextStyle (object)	The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.
Sheet.charts.spec.bubbleChart.bubbleMaxRadiusSize	api_schema_field	Bubble Max Radius Size	BubbleChartSpec.bubbleMaxRadiusSize (integer)	The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.
Sheet.charts.spec.bubbleChart.bubbleBorderColor	api_schema_field	Bubble Border Color	BubbleChartSpec.bubbleBorderColor (object)	The bubble border color. Deprecated: Use bubble_border_color_style.
Sheet.charts.spec.bubbleChart.bubbleSizes	api_schema_field	Bubble Sizes	BubbleChartSpec.bubbleSizes (object)	The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional.
Sheet.charts.spec.bubbleChart.groupIds	api_schema_field	Group Ids	BubbleChartSpec.groupIds (object)	The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional.
Sheet.charts.spec.bubbleChart.bubbleLabels	api_schema_field	Bubble Labels	BubbleChartSpec.bubbleLabels (object)	The data containing the bubble labels. These do not need to be unique.
Sheet.charts.spec.bubbleChart.bubbleMinRadiusSize	api_schema_field	Bubble Min Radius Size	BubbleChartSpec.bubbleMinRadiusSize (integer)	The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.
Sheet.charts.spec.bubbleChart.series	api_schema_field	Series	BubbleChartSpec.series (object)	The data containing the bubble y-values. These values locate the bubbles in the chart vertically.
Sheet.charts.spec.bubbleChart.bubbleOpacity	api_schema_field	Bubble Opacity	BubbleChartSpec.bubbleOpacity (number)	The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
Sheet.charts.spec.bubbleChart.bubbleBorderColorStyle	api_schema_field	Bubble Border Color Style	BubbleChartSpec.bubbleBorderColorStyle (object)	The bubble border color. If bubble_border_color is also set, this field takes precedence.
Sheet.charts.spec.bubbleChart.legendPosition	api_schema_field	Legend Position	BubbleChartSpec.legendPosition (string)	Where the legend of the chart should be drawn.
Sheet.charts.spec.bubbleChart.domain	api_schema_field	Domain	BubbleChartSpec.domain (object)	The data containing the bubble x-values. These values locate the bubbles in the chart horizontally.
Sheet.charts.spec.histogramChart	api_schema_field	Histogram Chart	ChartSpec.histogramChart (object)	A histogram chart specification.
Sheet.charts.spec.histogramChart.legendPosition	api_schema_field	Legend Position	HistogramChartSpec.legendPosition (string)	The position of the chart legend.
Sheet.charts.spec.histogramChart.bucketSize	api_schema_field	Bucket Size	HistogramChartSpec.bucketSize (number)	By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.
Sheet.charts.spec.histogramChart.showItemDividers	api_schema_field	Show Item Dividers	HistogramChartSpec.showItemDividers (boolean)	Whether horizontal divider lines should be displayed between items in each column.
Sheet.charts.spec.histogramChart.outlierPercentile	api_schema_field	Outlier Percentile	HistogramChartSpec.outlierPercentile (number)	The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still in…
Sheet.charts.spec.histogramChart.series	api_schema_field	Series	HistogramChartSpec.series (array)	The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.
Sheet.charts.spec.scorecardChart	api_schema_field	Scorecard Chart	ChartSpec.scorecardChart (object)	A scorecard chart specification.
Sheet.charts.spec.scorecardChart.keyValueData	api_schema_field	Key Value Data	ScorecardChartSpec.keyValueData (object)	The data for scorecard key value.
Sheet.charts.spec.scorecardChart.baselineValueData	api_schema_field	Baseline Value Data	ScorecardChartSpec.baselineValueData (object)	The data for scorecard baseline value. This field is optional.
Sheet.charts.spec.scorecardChart.baselineValueFormat	api_schema_field	Baseline Value Format	ScorecardChartSpec.baselineValueFormat (object)	Formatting options for baseline value. This field is needed only if baseline_value_data is specified.
Sheet.charts.spec.scorecardChart.scaleFactor	api_schema_field	Scale Factor	ScorecardChartSpec.scaleFactor (number)	Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.
Sheet.charts.spec.scorecardChart.aggregateType	api_schema_field	Aggregate Type	ScorecardChartSpec.aggregateType (string)	The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optio…
Sheet.charts.spec.scorecardChart.numberFormatSource	api_schema_field	Number Format Source	ScorecardChartSpec.numberFormatSource (string)	The number format source used in the scorecard chart. This field is optional.
Sheet.charts.spec.scorecardChart.customFormatOptions	api_schema_field	Custom Format Options	ScorecardChartSpec.customFormatOptions (object)	Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional.
Sheet.charts.spec.scorecardChart.keyValueFormat	api_schema_field	Key Value Format	ScorecardChartSpec.keyValueFormat (object)	Formatting options for key value.
Sheet.charts.spec.waterfallChart	api_schema_field	Waterfall Chart	ChartSpec.waterfallChart (object)	A waterfall chart specification.
Sheet.charts.spec.waterfallChart.domain	api_schema_field	Domain	WaterfallChartSpec.domain (object)	The domain data (horizontal axis) for the waterfall chart.
Sheet.charts.spec.waterfallChart.totalDataLabel	api_schema_field	Total Data Label	WaterfallChartSpec.totalDataLabel (object)	Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label.
Sheet.charts.spec.waterfallChart.stackedType	api_schema_field	Stacked Type	WaterfallChartSpec.stackedType (string)	The stacked type.
Sheet.charts.spec.waterfallChart.firstValueIsTotal	api_schema_field	First Value Is Total	WaterfallChartSpec.firstValueIsTotal (boolean)	True to interpret the first value as a total.
Sheet.charts.spec.waterfallChart.hideConnectorLines	api_schema_field	Hide Connector Lines	WaterfallChartSpec.hideConnectorLines (boolean)	True to hide connector lines between columns.
Sheet.charts.spec.waterfallChart.series	api_schema_field	Series	WaterfallChartSpec.series (array)	The data this waterfall chart is visualizing.
Sheet.charts.spec.waterfallChart.connectorLineStyle	api_schema_field	Connector Line Style	WaterfallChartSpec.connectorLineStyle (object)	The line style for the connector lines.
Sheet.charts.spec.candlestickChart	api_schema_field	Candlestick Chart	ChartSpec.candlestickChart (object)	A candlestick chart specification.
Sheet.charts.spec.candlestickChart.domain	api_schema_field	Domain	CandlestickChartSpec.domain (object)	The domain data (horizontal axis) for the candlestick chart. String data will be treated as discrete labels, other data will be treated as continuous values.
Sheet.charts.spec.candlestickChart.data	api_schema_field	Data	CandlestickChartSpec.data (array)	The Candlestick chart data. Only one CandlestickData is supported.
Sheet.charts.spec.altText	api_schema_field	Alt Text	ChartSpec.altText (string)	The alternative text that describes the chart. This is often used for accessibility.
Sheet.charts.spec.basicChart	api_schema_field	Basic Chart	ChartSpec.basicChart (object)	A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
Sheet.charts.spec.basicChart.chartType	api_schema_field	Chart Type	BasicChartSpec.chartType (string)	The type of the chart.
Sheet.charts.spec.basicChart.legendPosition	api_schema_field	Legend Position	BasicChartSpec.legendPosition (string)	The position of the chart legend.
Sheet.charts.spec.basicChart.axis	api_schema_field	Axis	BasicChartSpec.axis (array)	The axis on the chart.
Sheet.charts.spec.basicChart.threeDimensional	api_schema_field	Three Dimensional	BasicChartSpec.threeDimensional (boolean)	True to make the chart 3D. Applies to Bar and Column charts.
Sheet.charts.spec.basicChart.series	api_schema_field	Series	BasicChartSpec.series (array)	The data this chart is visualizing.
Sheet.charts.spec.basicChart.stackedType	api_schema_field	Stacked Type	BasicChartSpec.stackedType (string)	The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.
Sheet.charts.spec.basicChart.headerCount	api_schema_field	Header Count	BasicChartSpec.headerCount (integer)	The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)
Sheet.charts.spec.basicChart.lineSmoothing	api_schema_field	Line Smoothing	BasicChartSpec.lineSmoothing (boolean)	Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.
Sheet.charts.spec.basicChart.totalDataLabel	api_schema_field	Total Data Label	BasicChartSpec.totalDataLabel (object)	Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and…
Sheet.charts.spec.basicChart.interpolateNulls	api_schema_field	Interpolate Nulls	BasicChartSpec.interpolateNulls (boolean)	If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.
Sheet.charts.spec.basicChart.domains	api_schema_field	Domains	BasicChartSpec.domains (array)	The domain of data this is charting. Only a single domain is supported.
Sheet.charts.spec.basicChart.compareMode	api_schema_field	Compare Mode	BasicChartSpec.compareMode (string)	The behavior of tooltips and data highlighting when hovering on data and chart area.
Sheet.charts.spec.subtitle	api_schema_field	Subtitle	ChartSpec.subtitle (string)	The subtitle of the chart.
Sheet.charts.spec.subtitleTextPosition	api_schema_field	Subtitle Text Position	ChartSpec.subtitleTextPosition (object)	The subtitle text position. This field is optional.
Sheet.charts.spec.subtitleTextPosition.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
Sheet.charts.spec.backgroundColor	api_schema_field	Background Color	ChartSpec.backgroundColor (object)	The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
Sheet.charts.spec.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.charts.spec.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.charts.spec.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.charts.spec.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.charts.spec.pieChart	api_schema_field	Pie Chart	ChartSpec.pieChart (object)	A pie chart specification.
Sheet.charts.spec.pieChart.series	api_schema_field	Series	PieChartSpec.series (object)	The data that covers the one and only series of the pie chart.
Sheet.charts.spec.pieChart.domain	api_schema_field	Domain	PieChartSpec.domain (object)	The data that covers the domain of the pie chart.
Sheet.charts.spec.pieChart.threeDimensional	api_schema_field	Three Dimensional	PieChartSpec.threeDimensional (boolean)	True if the pie is three dimensional.
Sheet.charts.spec.pieChart.pieHole	api_schema_field	Pie Hole	PieChartSpec.pieHole (number)	The size of the hole in the pie chart.
Sheet.charts.spec.pieChart.legendPosition	api_schema_field	Legend Position	PieChartSpec.legendPosition (string)	Where the legend of the pie chart should be drawn.
Sheet.charts.spec.treemapChart	api_schema_field	Treemap Chart	ChartSpec.treemapChart (object)	A treemap chart specification.
Sheet.charts.spec.treemapChart.headerColorStyle	api_schema_field	Header Color Style	TreemapChartSpec.headerColorStyle (object)	The background color for header cells. If header_color is also set, this field takes precedence.
Sheet.charts.spec.treemapChart.textFormat	api_schema_field	Text Format	TreemapChartSpec.textFormat (object)	The text format for all labels on the chart. The link field is not supported.
Sheet.charts.spec.treemapChart.parentLabels	api_schema_field	Parent Labels	TreemapChartSpec.parentLabels (object)	The data the contains the treemap cells' parent labels.
Sheet.charts.spec.treemapChart.levels	api_schema_field	Levels	TreemapChartSpec.levels (integer)	The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.
Sheet.charts.spec.treemapChart.hideTooltips	api_schema_field	Hide Tooltips	TreemapChartSpec.hideTooltips (boolean)	True to hide tooltips.
Sheet.charts.spec.treemapChart.sizeData	api_schema_field	Size Data	TreemapChartSpec.sizeData (object)	The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background…
Sheet.charts.spec.treemapChart.headerColor	api_schema_field	Header Color	TreemapChartSpec.headerColor (object)	The background color for header cells. Deprecated: Use header_color_style.
Sheet.charts.spec.treemapChart.labels	api_schema_field	Labels	TreemapChartSpec.labels (object)	The data that contains the treemap cell labels.
Sheet.charts.spec.treemapChart.colorData	api_schema_field	Color Data	TreemapChartSpec.colorData (object)	The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in…
Sheet.charts.spec.treemapChart.minValue	api_schema_field	Min Value	TreemapChartSpec.minValue (number)	The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.
Sheet.charts.spec.treemapChart.maxValue	api_schema_field	Max Value	TreemapChartSpec.maxValue (number)	The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.
Sheet.charts.spec.treemapChart.hintedLevels	api_schema_field	Hinted Levels	TreemapChartSpec.hintedLevels (integer)	The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.
Sheet.charts.spec.treemapChart.colorScale	api_schema_field	Color Scale	TreemapChartSpec.colorScale (object)	The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value…
Sheet.charts.spec.fontName	schema_pii_or_identity_field	Font Name	ChartSpec.fontName (string)	The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
Sheet.charts.spec.subtitleTextFormat	api_schema_field	Subtitle Text Format	ChartSpec.subtitleTextFormat (object)	The subtitle text format. Strikethrough, underline, and link are not supported.
Sheet.charts.spec.subtitleTextFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
Sheet.charts.spec.subtitleTextFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
Sheet.charts.spec.subtitleTextFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
Sheet.charts.spec.subtitleTextFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
Sheet.charts.spec.subtitleTextFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
Sheet.charts.spec.subtitleTextFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
Sheet.charts.spec.subtitleTextFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
Sheet.charts.spec.subtitleTextFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
Sheet.charts.spec.subtitleTextFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
Sheet.charts.spec.sortSpecs	api_schema_field	Sort Specs	ChartSpec.sortSpecs (array)	The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
Sheet.charts.spec.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.charts.spec.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
Sheet.charts.spec.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
Sheet.charts.spec.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
Sheet.charts.spec.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
Sheet.charts.spec.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
Sheet.charts.spec.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
Sheet.charts.spec.titleTextPosition	api_schema_field	Title Text Position	ChartSpec.titleTextPosition (object)	The title text position. This field is optional.
Sheet.charts.spec.titleTextPosition.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
Sheet.charts.position	api_schema_field	Position	EmbeddedChart.position (object)	The position of the chart.
Sheet.charts.position.newSheet	api_schema_field	New Sheet	EmbeddedObjectPosition.newSheet (boolean)	If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.
Sheet.charts.position.sheetId	api_schema_field	Sheet Id	EmbeddedObjectPosition.sheetId (integer)	The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.
Sheet.charts.position.overlayPosition	api_schema_field	Overlay Position	EmbeddedObjectPosition.overlayPosition (object)	The position at which the object is overlaid on top of a grid.
Sheet.charts.position.overlayPosition.widthPixels	api_schema_field	Width Pixels	OverlayPosition.widthPixels (integer)	The width of the object, in pixels. Defaults to 600.
Sheet.charts.position.overlayPosition.anchorCell	api_schema_field	Anchor Cell	OverlayPosition.anchorCell (object)	The cell the object is anchored to.
Sheet.charts.position.overlayPosition.offsetXPixels	api_schema_field	Offset XPixels	OverlayPosition.offsetXPixels (integer)	The horizontal offset, in pixels, that the object is offset from the anchor cell.
Sheet.charts.position.overlayPosition.heightPixels	api_schema_field	Height Pixels	OverlayPosition.heightPixels (integer)	The height of the object, in pixels. Defaults to 371.
Sheet.charts.position.overlayPosition.offsetYPixels	api_schema_field	Offset YPixels	OverlayPosition.offsetYPixels (integer)	The vertical offset, in pixels, that the object is offset from the anchor cell.
Sheet.charts.border	api_schema_field	Border	EmbeddedChart.border (object)	The border of the chart.
Sheet.charts.border.color	api_schema_field	Color	EmbeddedObjectBorder.color (object)	The color of the border. Deprecated: Use color_style.
Sheet.charts.border.color.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.charts.border.color.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.charts.border.color.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.charts.border.color.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.charts.border.colorStyle	api_schema_field	Color Style	EmbeddedObjectBorder.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
Sheet.charts.border.colorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.charts.border.colorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.slicers	api_schema_field	Slicers	Sheet.slicers (array)	The slicers on this sheet.
Sheet.slicers.spec	api_schema_field	Spec	Slicer.spec (object)	The specification of the slicer.
Sheet.slicers.spec.backgroundColor	api_schema_field	Background Color	SlicerSpec.backgroundColor (object)	The background color of the slicer. Deprecated: Use background_color_style.
Sheet.slicers.spec.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.slicers.spec.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.slicers.spec.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.slicers.spec.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.slicers.spec.columnIndex	api_schema_field	Column Index	SlicerSpec.columnIndex (integer)	The zero-based column index in the data table on which the filter is applied to.
Sheet.slicers.spec.dataRange	api_schema_field	Data Range	SlicerSpec.dataRange (object)	The data range of the slicer.
Sheet.slicers.spec.dataRange.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.slicers.spec.dataRange.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.slicers.spec.dataRange.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.slicers.spec.dataRange.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.slicers.spec.dataRange.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.slicers.spec.filterCriteria	api_schema_field	Filter Criteria	SlicerSpec.filterCriteria (object)	The filtering criteria of the slicer.
Sheet.slicers.spec.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
Sheet.slicers.spec.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
Sheet.slicers.spec.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
Sheet.slicers.spec.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
Sheet.slicers.spec.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
Sheet.slicers.spec.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
Sheet.slicers.spec.applyToPivotTables	api_schema_field	Apply To Pivot Tables	SlicerSpec.applyToPivotTables (boolean)	True if the filter should apply to pivot tables. If not set, default to `True`.
Sheet.slicers.spec.horizontalAlignment	api_schema_field	Horizontal Alignment	SlicerSpec.horizontalAlignment (string)	The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`
Sheet.slicers.spec.textFormat	api_schema_field	Text Format	SlicerSpec.textFormat (object)	The text format of title in the slicer. The link field is not supported.
Sheet.slicers.spec.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
Sheet.slicers.spec.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
Sheet.slicers.spec.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
Sheet.slicers.spec.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
Sheet.slicers.spec.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
Sheet.slicers.spec.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
Sheet.slicers.spec.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
Sheet.slicers.spec.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
Sheet.slicers.spec.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
Sheet.slicers.spec.title	api_schema_field	Title	SlicerSpec.title (string)	The title of the slicer.
Sheet.slicers.spec.backgroundColorStyle	api_schema_field	Background Color Style	SlicerSpec.backgroundColorStyle (object)	The background color of the slicer. If background_color is also set, this field takes precedence.
Sheet.slicers.spec.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.slicers.spec.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.slicers.position	api_schema_field	Position	Slicer.position (object)	The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits.
Sheet.slicers.position.newSheet	api_schema_field	New Sheet	EmbeddedObjectPosition.newSheet (boolean)	If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.
Sheet.slicers.position.sheetId	api_schema_field	Sheet Id	EmbeddedObjectPosition.sheetId (integer)	The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.
Sheet.slicers.position.overlayPosition	api_schema_field	Overlay Position	EmbeddedObjectPosition.overlayPosition (object)	The position at which the object is overlaid on top of a grid.
Sheet.slicers.position.overlayPosition.widthPixels	api_schema_field	Width Pixels	OverlayPosition.widthPixels (integer)	The width of the object, in pixels. Defaults to 600.
Sheet.slicers.position.overlayPosition.anchorCell	api_schema_field	Anchor Cell	OverlayPosition.anchorCell (object)	The cell the object is anchored to.
Sheet.slicers.position.overlayPosition.offsetXPixels	api_schema_field	Offset XPixels	OverlayPosition.offsetXPixels (integer)	The horizontal offset, in pixels, that the object is offset from the anchor cell.
Sheet.slicers.position.overlayPosition.heightPixels	api_schema_field	Height Pixels	OverlayPosition.heightPixels (integer)	The height of the object, in pixels. Defaults to 371.
Sheet.slicers.position.overlayPosition.offsetYPixels	api_schema_field	Offset YPixels	OverlayPosition.offsetYPixels (integer)	The vertical offset, in pixels, that the object is offset from the anchor cell.
Sheet.slicers.slicerId	api_schema_field	Slicer Id	Slicer.slicerId (integer)	The ID of the slicer.
Sheet.protectedRanges	api_schema_field	Protected Ranges	Sheet.protectedRanges (array)	The protected ranges in this sheet.
Sheet.protectedRanges.tableId	api_schema_field	Table Id	ProtectedRange.tableId (string)	The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.
Sheet.protectedRanges.namedRangeId	schema_pii_or_identity_field	Named Range Id	ProtectedRange.namedRangeId (string)	The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.
Sheet.protectedRanges.unprotectedRanges	api_schema_field	Unprotected Ranges	ProtectedRange.unprotectedRanges (array)	The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.
Sheet.protectedRanges.unprotectedRanges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.protectedRanges.unprotectedRanges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.unprotectedRanges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.unprotectedRanges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.unprotectedRanges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.editors	api_schema_field	Editors	ProtectedRange.editors (object)	The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection.
Sheet.protectedRanges.editors.domainUsersCanEdit	api_schema_field	Domain Users Can Edit	Editors.domainUsersCanEdit (boolean)	True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.
Sheet.protectedRanges.editors.users	api_schema_field	Users	Editors.users (array)	The email addresses of users with edit access to the protected range.
Sheet.protectedRanges.editors.groups	api_schema_field	Groups	Editors.groups (array)	The email addresses of groups with edit access to the protected range.
Sheet.protectedRanges.protectedRangeId	api_schema_field	Protected Range Id	ProtectedRange.protectedRangeId (integer)	The ID of the protected range. This field is read-only.
Sheet.protectedRanges.range	api_schema_field	Range	ProtectedRange.range (object)	The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set.
Sheet.protectedRanges.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.protectedRanges.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.protectedRanges.requestingUserCanEdit	api_schema_field	Requesting User Can Edit	ProtectedRange.requestingUserCanEdit (boolean)	True if the user who requested this protected range can edit the protected area. This field is read-only.
Sheet.protectedRanges.warningOnly	api_schema_field	Warning Only	ProtectedRange.warningOnly (boolean)	True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true,…
Sheet.protectedRanges.description	api_schema_field	Description	ProtectedRange.description (string)	The description of this protected range.
Sheet.rowGroups	api_schema_field	Row Groups	Sheet.rowGroups (array)	All row groups on this sheet, ordered by increasing range start index, then by group depth.
Sheet.rowGroups.depth	api_schema_field	Depth	DimensionGroup.depth (integer)	The depth of the group, representing how many groups have a range that wholly contains the range of this group.
Sheet.rowGroups.collapsed	api_schema_field	Collapsed	DimensionGroup.collapsed (boolean)	This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change…
Sheet.rowGroups.range	api_schema_field	Range	DimensionGroup.range (object)	The range over which this group exists.
Sheet.rowGroups.range.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Sheet.rowGroups.range.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Sheet.rowGroups.range.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Sheet.rowGroups.range.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Sheet.developerMetadata	api_schema_field	Developer Metadata	Sheet.developerMetadata (array)	The developer metadata associated with a sheet.
Sheet.developerMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
Sheet.developerMetadata.location.locationType	api_schema_field	Location Type	DeveloperMetadataLocation.locationType (string)	The type of location this object represents. This field is read-only.
Sheet.developerMetadata.location.sheetId	api_schema_field	Sheet Id	DeveloperMetadataLocation.sheetId (integer)	The ID of the sheet when metadata is associated with an entire sheet.
Sheet.developerMetadata.location.dimensionRange	api_schema_field	Dimension Range	DeveloperMetadataLocation.dimensionRange (object)	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
Sheet.developerMetadata.location.dimensionRange.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
Sheet.developerMetadata.location.dimensionRange.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
Sheet.developerMetadata.location.dimensionRange.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
Sheet.developerMetadata.location.dimensionRange.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
Sheet.developerMetadata.location.spreadsheet	api_schema_field	Spreadsheet	DeveloperMetadataLocation.spreadsheet (boolean)	True when metadata is associated with an entire spreadsheet.
Sheet.developerMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
Sheet.developerMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
Sheet.developerMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
Sheet.developerMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
Sheet.tables	api_schema_field	Tables	Sheet.tables (array)	The tables on this sheet.
Sheet.tables.columnProperties	api_schema_field	Column Properties	Table.columnProperties (array)	The table column properties.
Sheet.tables.columnProperties.columnIndex	api_schema_field	Column Index	TableColumnProperties.columnIndex (integer)	The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.
Sheet.tables.columnProperties.dataValidationRule	api_schema_field	Data Validation Rule	TableColumnProperties.dataValidationRule (object)	The column data validation rule. Only set for dropdown column type.
Sheet.tables.columnProperties.dataValidationRule.condition	api_schema_field	Condition	TableColumnDataValidationRule.condition (object)	The condition that data in the cell must match. Valid only if the [BooleanCondition.type] is ONE_OF_LIST.
Sheet.tables.columnProperties.columnName	schema_pii_or_identity_field	Column Name	TableColumnProperties.columnName (string)	The column name.
Sheet.tables.columnProperties.columnType	api_schema_field	Column Type	TableColumnProperties.columnType (string)	The column type.
Sheet.tables.rowsProperties	api_schema_field	Rows Properties	Table.rowsProperties (object)	The table rows properties.
Sheet.tables.rowsProperties.footerColorStyle	api_schema_field	Footer Color Style	TableRowsProperties.footerColorStyle (object)	The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have…
Sheet.tables.rowsProperties.footerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.tables.rowsProperties.footerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.tables.rowsProperties.headerColorStyle	api_schema_field	Header Color Style	TableRowsProperties.headerColorStyle (object)	The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color.
Sheet.tables.rowsProperties.headerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.tables.rowsProperties.headerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.tables.rowsProperties.firstBandColorStyle	api_schema_field	First Band Color Style	TableRowsProperties.firstBandColorStyle (object)	The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color.
Sheet.tables.rowsProperties.firstBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.tables.rowsProperties.firstBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.tables.rowsProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	TableRowsProperties.secondBandColorStyle (object)	The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color.
Sheet.tables.rowsProperties.secondBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.tables.rowsProperties.secondBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.tables.tableId	api_schema_field	Table Id	Table.tableId (string)	The id of the table.
Sheet.tables.range	api_schema_field	Range	Table.range (object)	The table range.
Sheet.tables.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.tables.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.tables.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.tables.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.tables.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.tables.name	schema_pii_or_identity_field	Name	Table.name (string)	The table name. This is unique to all tables in the same spreadsheet.
Sheet.data	api_schema_field	Data	Sheet.data (array)	Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `…
Sheet.data.startColumn	api_schema_field	Start Column	GridData.startColumn (integer)	The first column this GridData refers to, zero-based.
Sheet.data.rowData	api_schema_field	Row Data	GridData.rowData (array)	The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.
Sheet.data.rowData.values	api_schema_field	Values	RowData.values (array)	The values in the row, one per column.
Sheet.data.rowData.values.chipRuns	api_schema_field	Chip Runs	CellData.chipRuns (array)	Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty Chip. When…
Sheet.data.rowData.values.dataValidation	api_schema_field	Data Validation	CellData.dataValidation (object)	A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule.
Sheet.data.rowData.values.dataSourceTable	api_schema_field	Data Source Table	CellData.dataSourceTable (object)	A data source table anchored at this cell. The size of data source table itself is computed dynamically based on its configuration. Only the first cell of the data source table contains the data source table definition. The other cells will contain the displa…
Sheet.data.rowData.values.effectiveValue	api_schema_field	Effective Value	CellData.effectiveValue (object)	The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only.
Sheet.data.rowData.values.note	api_schema_field	Note	CellData.note (string)	Any note on the cell.
Sheet.data.rowData.values.textFormatRuns	api_schema_field	Text Format Runs	CellData.textFormatRuns (array)	Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of…
Sheet.data.rowData.values.pivotTable	api_schema_field	Pivot Table	CellData.pivotTable (object)	A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calc…
Sheet.data.rowData.values.hyperlink	api_schema_field	Hyperlink	CellData.hyperlink (string)	A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the…
Sheet.data.rowData.values.userEnteredValue	api_schema_field	User Entered Value	CellData.userEnteredValue (object)	The value the user entered in the cell. e.g., `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format.
Sheet.data.rowData.values.formattedValue	api_schema_field	Formatted Value	CellData.formattedValue (string)	The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.
Sheet.data.rowData.values.effectiveFormat	api_schema_field	Effective Format	CellData.effectiveFormat (object)	The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written.…
Sheet.data.rowData.values.userEnteredFormat	api_schema_field	User Entered Format	CellData.userEnteredFormat (object)	The format the user entered for the cell. When writing, the new format will be merged with the existing format.
Sheet.data.rowData.values.dataSourceFormula	api_schema_field	Data Source Formula	CellData.dataSourceFormula (object)	Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`.
Sheet.data.rowMetadata	api_schema_field	Row Metadata	GridData.rowMetadata (array)	Metadata about the requested rows in the grid, starting with the row in start_row.
Sheet.data.rowMetadata.pixelSize	api_schema_field	Pixel Size	DimensionProperties.pixelSize (integer)	The height (if a row) or width (if a column) of the dimension in pixels.
Sheet.data.rowMetadata.developerMetadata	api_schema_field	Developer Metadata	DimensionProperties.developerMetadata (array)	The developer metadata associated with a single row or column.
Sheet.data.rowMetadata.developerMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
Sheet.data.rowMetadata.developerMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
Sheet.data.rowMetadata.developerMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
Sheet.data.rowMetadata.developerMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
Sheet.data.rowMetadata.developerMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
Sheet.data.rowMetadata.hiddenByUser	api_schema_field	Hidden By User	DimensionProperties.hiddenByUser (boolean)	True if this dimension is explicitly hidden.
Sheet.data.rowMetadata.dataSourceColumnReference	api_schema_field	Data Source Column Reference	DimensionProperties.dataSourceColumnReference (object)	Output only. If set, this is a column in a data source sheet.
Sheet.data.rowMetadata.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.data.rowMetadata.hiddenByFilter	api_schema_field	Hidden By Filter	DimensionProperties.hiddenByFilter (boolean)	True if this dimension is being filtered. This field is read-only.
Sheet.data.startRow	api_schema_field	Start Row	GridData.startRow (integer)	The first row this GridData refers to, zero-based.
Sheet.data.columnMetadata	api_schema_field	Column Metadata	GridData.columnMetadata (array)	Metadata about the requested columns in the grid, starting with the column in start_column.
Sheet.data.columnMetadata.pixelSize	api_schema_field	Pixel Size	DimensionProperties.pixelSize (integer)	The height (if a row) or width (if a column) of the dimension in pixels.
Sheet.data.columnMetadata.developerMetadata	api_schema_field	Developer Metadata	DimensionProperties.developerMetadata (array)	The developer metadata associated with a single row or column.
Sheet.data.columnMetadata.developerMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
Sheet.data.columnMetadata.developerMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
Sheet.data.columnMetadata.developerMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
Sheet.data.columnMetadata.developerMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
Sheet.data.columnMetadata.developerMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
Sheet.data.columnMetadata.hiddenByUser	api_schema_field	Hidden By User	DimensionProperties.hiddenByUser (boolean)	True if this dimension is explicitly hidden.
Sheet.data.columnMetadata.dataSourceColumnReference	api_schema_field	Data Source Column Reference	DimensionProperties.dataSourceColumnReference (object)	Output only. If set, this is a column in a data source sheet.
Sheet.data.columnMetadata.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.data.columnMetadata.hiddenByFilter	api_schema_field	Hidden By Filter	DimensionProperties.hiddenByFilter (boolean)	True if this dimension is being filtered. This field is read-only.
Sheet.filterViews	api_schema_field	Filter Views	Sheet.filterViews (array)	The filter views in this sheet.
Sheet.filterViews.sortSpecs	api_schema_field	Sort Specs	FilterView.sortSpecs (array)	The sort order per column. Later specifications are used when values are equal in the earlier specifications.
Sheet.filterViews.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.filterViews.sortSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.filterViews.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
Sheet.filterViews.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
Sheet.filterViews.sortSpecs.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.filterViews.sortSpecs.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.filterViews.sortSpecs.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.filterViews.sortSpecs.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.filterViews.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
Sheet.filterViews.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
Sheet.filterViews.sortSpecs.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.filterViews.sortSpecs.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.filterViews.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
Sheet.filterViews.sortSpecs.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.filterViews.sortSpecs.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.filterViews.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
Sheet.filterViews.sortSpecs.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.filterViews.sortSpecs.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.filterViews.sortSpecs.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.filterViews.sortSpecs.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.filterViews.filterViewId	api_schema_field	Filter View Id	FilterView.filterViewId (integer)	The ID of the filter view.
Sheet.filterViews.namedRangeId	schema_pii_or_identity_field	Named Range Id	FilterView.namedRangeId (string)	The named range this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.
Sheet.filterViews.filterSpecs	api_schema_field	Filter Specs	FilterView.filterSpecs (array)	The filter criteria for showing or hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
Sheet.filterViews.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
Sheet.filterViews.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
Sheet.filterViews.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
Sheet.filterViews.filterSpecs.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
Sheet.filterViews.filterSpecs.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
Sheet.filterViews.filterSpecs.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
Sheet.filterViews.filterSpecs.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
Sheet.filterViews.filterSpecs.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
Sheet.filterViews.filterSpecs.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
Sheet.filterViews.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
Sheet.filterViews.range	api_schema_field	Range	FilterView.range (object)	The range this filter view covers. When writing, only one of range, named_range_id, or table_id may be set.
Sheet.filterViews.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.filterViews.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.filterViews.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.filterViews.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.filterViews.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.filterViews.tableId	api_schema_field	Table Id	FilterView.tableId (string)	The table this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.
Sheet.filterViews.criteria	api_schema_field	Criteria	FilterView.criteria (object)	The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.
Sheet.filterViews.title	api_schema_field	Title	FilterView.title (string)	The name of the filter view.
Sheet.bandedRanges	api_schema_field	Banded Ranges	Sheet.bandedRanges (array)	The banded (alternating colors) ranges on this sheet.
Sheet.bandedRanges.bandedRangeId	api_schema_field	Banded Range Id	BandedRange.bandedRangeId (integer)	The ID of the banded range. If unset, refer to banded_range_reference.
Sheet.bandedRanges.bandedRangeReference	api_schema_field	Banded Range Reference	BandedRange.bandedRangeReference (string)	Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.
Sheet.bandedRanges.rowProperties	api_schema_field	Row Properties	BandedRange.rowProperties (object)	Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of row_properties or column_properties must be specified.
Sheet.bandedRanges.rowProperties.headerColor	api_schema_field	Header Color	BandingProperties.headerColor (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Sheet.bandedRanges.rowProperties.headerColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.headerColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.headerColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.rowProperties.headerColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.headerColorStyle	api_schema_field	Header Color Style	BandingProperties.headerColorStyle (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Sheet.bandedRanges.rowProperties.headerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.rowProperties.headerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.rowProperties.firstBandColorStyle	api_schema_field	First Band Color Style	BandingProperties.firstBandColorStyle (object)	The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
Sheet.bandedRanges.rowProperties.firstBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.rowProperties.firstBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.rowProperties.secondBandColor	api_schema_field	Second Band Color	BandingProperties.secondBandColor (object)	The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
Sheet.bandedRanges.rowProperties.secondBandColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.secondBandColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.secondBandColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.rowProperties.secondBandColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	BandingProperties.secondBandColorStyle (object)	The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
Sheet.bandedRanges.rowProperties.secondBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.rowProperties.secondBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.rowProperties.firstBandColor	api_schema_field	First Band Color	BandingProperties.firstBandColor (object)	The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
Sheet.bandedRanges.rowProperties.firstBandColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.firstBandColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.firstBandColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.rowProperties.firstBandColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.footerColor	api_schema_field	Footer Color	BandingProperties.footerColor (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.
Sheet.bandedRanges.rowProperties.footerColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.footerColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.footerColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.rowProperties.footerColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.rowProperties.footerColorStyle	api_schema_field	Footer Color Style	BandingProperties.footerColorStyle (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
Sheet.bandedRanges.rowProperties.footerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.rowProperties.footerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.columnProperties	api_schema_field	Column Properties	BandedRange.columnProperties (object)	Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified.
Sheet.bandedRanges.columnProperties.headerColor	api_schema_field	Header Color	BandingProperties.headerColor (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Sheet.bandedRanges.columnProperties.headerColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.headerColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.headerColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.columnProperties.headerColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.headerColorStyle	api_schema_field	Header Color Style	BandingProperties.headerColorStyle (object)	The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is…
Sheet.bandedRanges.columnProperties.headerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.columnProperties.headerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.columnProperties.firstBandColorStyle	api_schema_field	First Band Color Style	BandingProperties.firstBandColorStyle (object)	The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence.
Sheet.bandedRanges.columnProperties.firstBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.columnProperties.firstBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.columnProperties.secondBandColor	api_schema_field	Second Band Color	BandingProperties.secondBandColor (object)	The second color that is alternating. (Required) Deprecated: Use second_band_color_style.
Sheet.bandedRanges.columnProperties.secondBandColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.secondBandColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.secondBandColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.columnProperties.secondBandColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.secondBandColorStyle	api_schema_field	Second Band Color Style	BandingProperties.secondBandColorStyle (object)	The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence.
Sheet.bandedRanges.columnProperties.secondBandColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.columnProperties.secondBandColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.columnProperties.firstBandColor	api_schema_field	First Band Color	BandingProperties.firstBandColor (object)	The first color that is alternating. (Required) Deprecated: Use first_band_color_style.
Sheet.bandedRanges.columnProperties.firstBandColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.firstBandColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.firstBandColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.columnProperties.firstBandColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.footerColor	api_schema_field	Footer Color	BandingProperties.footerColor (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. Deprecated: Use footer_color_style.
Sheet.bandedRanges.columnProperties.footerColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.footerColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.footerColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
Sheet.bandedRanges.columnProperties.footerColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
Sheet.bandedRanges.columnProperties.footerColorStyle	api_schema_field	Footer Color Style	BandingProperties.footerColorStyle (object)	The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence.
Sheet.bandedRanges.columnProperties.footerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
Sheet.bandedRanges.columnProperties.footerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
Sheet.bandedRanges.range	api_schema_field	Range	BandedRange.range (object)	The range over which these properties are applied.
Sheet.bandedRanges.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.bandedRanges.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.bandedRanges.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.bandedRanges.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.bandedRanges.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.conditionalFormats	api_schema_field	Conditional Formats	Sheet.conditionalFormats (array)	The conditional format rules in this sheet.
Sheet.conditionalFormats.ranges	api_schema_field	Ranges	ConditionalFormatRule.ranges (array)	The ranges that are formatted if the condition is true. All the ranges must be on the same grid.
Sheet.conditionalFormats.ranges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.conditionalFormats.ranges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.conditionalFormats.ranges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.conditionalFormats.ranges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.conditionalFormats.ranges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
Sheet.conditionalFormats.gradientRule	api_schema_field	Gradient Rule	ConditionalFormatRule.gradientRule (object)	The formatting will vary based on the gradients in the rule.
Sheet.conditionalFormats.gradientRule.minpoint	api_schema_field	Minpoint	GradientRule.minpoint (object)	The starting interpolation point.
Sheet.conditionalFormats.gradientRule.minpoint.color	api_schema_field	Color	InterpolationPoint.color (object)	The color this interpolation point should use. Deprecated: Use color_style.
Sheet.conditionalFormats.gradientRule.minpoint.colorStyle	api_schema_field	Color Style	InterpolationPoint.colorStyle (object)	The color this interpolation point should use. If color is also set, this field takes precedence.
Sheet.conditionalFormats.gradientRule.minpoint.value	api_schema_field	Value	InterpolationPoint.value (string)	The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.
Sheet.conditionalFormats.gradientRule.minpoint.type	api_schema_field	Type	InterpolationPoint.type (string)	How the value should be interpreted.
Sheet.conditionalFormats.gradientRule.midpoint	api_schema_field	Midpoint	GradientRule.midpoint (object)	An optional midway interpolation point.
Sheet.conditionalFormats.gradientRule.midpoint.color	api_schema_field	Color	InterpolationPoint.color (object)	The color this interpolation point should use. Deprecated: Use color_style.
Sheet.conditionalFormats.gradientRule.midpoint.colorStyle	api_schema_field	Color Style	InterpolationPoint.colorStyle (object)	The color this interpolation point should use. If color is also set, this field takes precedence.
Sheet.conditionalFormats.gradientRule.midpoint.value	api_schema_field	Value	InterpolationPoint.value (string)	The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.
Sheet.conditionalFormats.gradientRule.midpoint.type	api_schema_field	Type	InterpolationPoint.type (string)	How the value should be interpreted.
Sheet.conditionalFormats.gradientRule.maxpoint	api_schema_field	Maxpoint	GradientRule.maxpoint (object)	The final interpolation point.
Sheet.conditionalFormats.gradientRule.maxpoint.color	api_schema_field	Color	InterpolationPoint.color (object)	The color this interpolation point should use. Deprecated: Use color_style.
Sheet.conditionalFormats.gradientRule.maxpoint.colorStyle	api_schema_field	Color Style	InterpolationPoint.colorStyle (object)	The color this interpolation point should use. If color is also set, this field takes precedence.
Sheet.conditionalFormats.gradientRule.maxpoint.value	api_schema_field	Value	InterpolationPoint.value (string)	The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.
Sheet.conditionalFormats.gradientRule.maxpoint.type	api_schema_field	Type	InterpolationPoint.type (string)	How the value should be interpreted.
Sheet.conditionalFormats.booleanRule	api_schema_field	Boolean Rule	ConditionalFormatRule.booleanRule (object)	The formatting is either "on" or "off" according to the rule.
Sheet.conditionalFormats.booleanRule.condition	api_schema_field	Condition	BooleanRule.condition (object)	The condition of the rule. If the condition evaluates to true, the format is applied.
Sheet.conditionalFormats.booleanRule.condition.type	api_schema_field	Type	BooleanCondition.type (string)	The type of condition.
Sheet.conditionalFormats.booleanRule.condition.values	api_schema_field	Values	BooleanCondition.values (array)	The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
Sheet.conditionalFormats.booleanRule.format	api_schema_field	Format	BooleanRule.format (object)	The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color and, background color.
Sheet.conditionalFormats.booleanRule.format.numberFormat	api_schema_field	Number Format	CellFormat.numberFormat (object)	A format describing how number values should be represented to the user.
Sheet.conditionalFormats.booleanRule.format.textFormat	api_schema_field	Text Format	CellFormat.textFormat (object)	The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
Sheet.conditionalFormats.booleanRule.format.textRotation	api_schema_field	Text Rotation	CellFormat.textRotation (object)	The rotation applied to text in the cell.
Sheet.conditionalFormats.booleanRule.format.verticalAlignment	api_schema_field	Vertical Alignment	CellFormat.verticalAlignment (string)	The vertical alignment of the value in the cell.
Sheet.conditionalFormats.booleanRule.format.backgroundColorStyle	api_schema_field	Background Color Style	CellFormat.backgroundColorStyle (object)	The background color of the cell. If background_color is also set, this field takes precedence.
Sheet.conditionalFormats.booleanRule.format.textDirection	api_schema_field	Text Direction	CellFormat.textDirection (string)	The direction of the text in the cell.
Sheet.conditionalFormats.booleanRule.format.wrapStrategy	api_schema_field	Wrap Strategy	CellFormat.wrapStrategy (string)	The wrap strategy for the value in the cell.
Sheet.conditionalFormats.booleanRule.format.backgroundColor	api_schema_field	Background Color	CellFormat.backgroundColor (object)	The background color of the cell. Deprecated: Use background_color_style.
Sheet.conditionalFormats.booleanRule.format.borders	api_schema_field	Borders	CellFormat.borders (object)	The borders of the cell.
Sheet.conditionalFormats.booleanRule.format.padding	api_schema_field	Padding	CellFormat.padding (object)	The padding of the cell.
Sheet.conditionalFormats.booleanRule.format.hyperlinkDisplayType	api_schema_field	Hyperlink Display Type	CellFormat.hyperlinkDisplayType (string)	If one exists, how a hyperlink should be displayed in the cell.
Sheet.conditionalFormats.booleanRule.format.horizontalAlignment	api_schema_field	Horizontal Alignment	CellFormat.horizontalAlignment (string)	The horizontal alignment of the value in the cell.
Sheet.merges	api_schema_field	Merges	Sheet.merges (array)	The ranges that are merged together.
Sheet.merges.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
Sheet.merges.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
Sheet.merges.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
Sheet.merges.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
Sheet.merges.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
SheetProperties.title	api_schema_field	Title	SheetProperties.title (string)	The name of the sheet.
SheetProperties.gridProperties	api_schema_field	Grid Properties	SheetProperties.gridProperties (object)	Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOUR…
SheetProperties.gridProperties.frozenColumnCount	api_schema_field	Frozen Column Count	GridProperties.frozenColumnCount (integer)	The number of columns that are frozen in the grid.
SheetProperties.gridProperties.hideGridlines	api_schema_field	Hide Gridlines	GridProperties.hideGridlines (boolean)	True if the grid isn't showing gridlines in the UI.
SheetProperties.gridProperties.rowCount	api_schema_field	Row Count	GridProperties.rowCount (integer)	The number of rows in the grid.
SheetProperties.gridProperties.columnCount	api_schema_field	Column Count	GridProperties.columnCount (integer)	The number of columns in the grid.
SheetProperties.gridProperties.columnGroupControlAfter	api_schema_field	Column Group Control After	GridProperties.columnGroupControlAfter (boolean)	True if the column grouping control toggle is shown after the group.
SheetProperties.gridProperties.frozenRowCount	api_schema_field	Frozen Row Count	GridProperties.frozenRowCount (integer)	The number of rows that are frozen in the grid.
SheetProperties.gridProperties.rowGroupControlAfter	api_schema_field	Row Group Control After	GridProperties.rowGroupControlAfter (boolean)	True if the row grouping control toggle is shown after the group.
SheetProperties.tabColor	api_schema_field	Tab Color	SheetProperties.tabColor (object)	The color of the tab in the UI. Deprecated: Use tab_color_style.
SheetProperties.tabColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
SheetProperties.tabColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
SheetProperties.tabColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
SheetProperties.tabColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
SheetProperties.hidden	api_schema_field	Hidden	SheetProperties.hidden (boolean)	True if the sheet is hidden in the UI, false if it's visible.
SheetProperties.sheetType	api_schema_field	Sheet Type	SheetProperties.sheetType (string)	The type of sheet. Defaults to GRID. This field cannot be changed once set.
SheetProperties.dataSourceSheetProperties	api_schema_field	Data Source Sheet Properties	SheetProperties.dataSourceSheetProperties (object)	Output only. If present, the field contains DATA_SOURCE sheet specific properties.
SheetProperties.dataSourceSheetProperties.dataSourceId	api_schema_field	Data Source Id	DataSourceSheetProperties.dataSourceId (string)	ID of the DataSource the sheet is connected to.
SheetProperties.dataSourceSheetProperties.columns	api_schema_field	Columns	DataSourceSheetProperties.columns (array)	The columns displayed on the sheet, corresponding to the values in RowData.
SheetProperties.dataSourceSheetProperties.columns.formula	api_schema_field	Formula	DataSourceColumn.formula (string)	The formula of the calculated column.
SheetProperties.dataSourceSheetProperties.columns.reference	api_schema_field	Reference	DataSourceColumn.reference (object)	The column reference.
SheetProperties.dataSourceSheetProperties.columns.reference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
SheetProperties.dataSourceSheetProperties.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceSheetProperties.dataExecutionStatus (object)	The data execution status.
SheetProperties.dataSourceSheetProperties.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
SheetProperties.dataSourceSheetProperties.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
SheetProperties.dataSourceSheetProperties.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
SheetProperties.dataSourceSheetProperties.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
SheetProperties.index	api_schema_field	Index	SheetProperties.index (integer)	The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "befor…
SheetProperties.sheetId	api_schema_field	Sheet Id	SheetProperties.sheetId (integer)	The ID of the sheet. Must be non-negative. This field cannot be changed once set.
SheetProperties.rightToLeft	api_schema_field	Right To Left	SheetProperties.rightToLeft (boolean)	True if the sheet is an RTL sheet instead of an LTR sheet.
SheetProperties.tabColorStyle	api_schema_field	Tab Color Style	SheetProperties.tabColorStyle (object)	The color of the tab in the UI. If tab_color is also set, this field takes precedence.
SheetProperties.tabColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
SheetProperties.tabColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
SheetProperties.tabColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
SheetProperties.tabColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
SheetProperties.tabColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
SheetProperties.tabColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
GridProperties.frozenColumnCount	api_schema_field	Frozen Column Count	GridProperties.frozenColumnCount (integer)	The number of columns that are frozen in the grid.
GridProperties.hideGridlines	api_schema_field	Hide Gridlines	GridProperties.hideGridlines (boolean)	True if the grid isn't showing gridlines in the UI.
GridProperties.rowCount	api_schema_field	Row Count	GridProperties.rowCount (integer)	The number of rows in the grid.
GridProperties.columnCount	api_schema_field	Column Count	GridProperties.columnCount (integer)	The number of columns in the grid.
GridProperties.columnGroupControlAfter	api_schema_field	Column Group Control After	GridProperties.columnGroupControlAfter (boolean)	True if the column grouping control toggle is shown after the group.
GridProperties.frozenRowCount	api_schema_field	Frozen Row Count	GridProperties.frozenRowCount (integer)	The number of rows that are frozen in the grid.
GridProperties.rowGroupControlAfter	api_schema_field	Row Group Control After	GridProperties.rowGroupControlAfter (boolean)	True if the row grouping control toggle is shown after the group.
ValueRange.range	api_schema_field	Range	ValueRange.range (string)	The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending v…
ValueRange.majorDimension	api_schema_field	Major Dimension	ValueRange.majorDimension (string)	The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]…
ValueRange.values	api_schema_field	Values	ValueRange.values (array)	The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and col…
BatchGetValuesResponse.spreadsheetId	api_schema_field	Spreadsheet Id	BatchGetValuesResponse.spreadsheetId (string)	The ID of the spreadsheet the data was retrieved from.
BatchGetValuesResponse.valueRanges	api_schema_field	Value Ranges	BatchGetValuesResponse.valueRanges (array)	The requested values. The order of the ValueRanges is the same as the order of the requested ranges.
BatchGetValuesResponse.valueRanges.range	api_schema_field	Range	ValueRange.range (string)	The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending v…
BatchGetValuesResponse.valueRanges.majorDimension	api_schema_field	Major Dimension	ValueRange.majorDimension (string)	The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]…
BatchGetValuesResponse.valueRanges.values	api_schema_field	Values	ValueRange.values (array)	The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and col…
DeveloperMetadata.location	api_schema_field	Location	DeveloperMetadata.location (object)	The location where the metadata is associated.
DeveloperMetadata.location.locationType	api_schema_field	Location Type	DeveloperMetadataLocation.locationType (string)	The type of location this object represents. This field is read-only.
DeveloperMetadata.location.sheetId	api_schema_field	Sheet Id	DeveloperMetadataLocation.sheetId (integer)	The ID of the sheet when metadata is associated with an entire sheet.
DeveloperMetadata.location.dimensionRange	api_schema_field	Dimension Range	DeveloperMetadataLocation.dimensionRange (object)	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
DeveloperMetadata.location.dimensionRange.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
DeveloperMetadata.location.dimensionRange.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
DeveloperMetadata.location.dimensionRange.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
DeveloperMetadata.location.dimensionRange.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
DeveloperMetadata.location.spreadsheet	api_schema_field	Spreadsheet	DeveloperMetadataLocation.spreadsheet (boolean)	True when metadata is associated with an entire spreadsheet.
DeveloperMetadata.visibility	api_schema_field	Visibility	DeveloperMetadata.visibility (string)	The metadata visibility. Developer metadata must always have visibility specified.
DeveloperMetadata.metadataValue	api_schema_field	Metadata Value	DeveloperMetadata.metadataValue (string)	Data associated with the metadata's key.
DeveloperMetadata.metadataId	api_schema_field	Metadata Id	DeveloperMetadata.metadataId (integer)	The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
DeveloperMetadata.metadataKey	api_schema_field	Metadata Key	DeveloperMetadata.metadataKey (string)	The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
DataFilter.developerMetadataLookup	api_schema_field	Developer Metadata Lookup	DataFilter.developerMetadataLookup (object)	Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
DataFilter.developerMetadataLookup.locationType	api_schema_field	Location Type	DeveloperMetadataLookup.locationType (string)	Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecif…
DataFilter.developerMetadataLookup.metadataValue	api_schema_field	Metadata Value	DeveloperMetadataLookup.metadataValue (string)	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
DataFilter.developerMetadataLookup.metadataId	api_schema_field	Metadata Id	DeveloperMetadataLookup.metadataId (integer)	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
DataFilter.developerMetadataLookup.metadataKey	api_schema_field	Metadata Key	DeveloperMetadataLookup.metadataKey (string)	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
DataFilter.developerMetadataLookup.locationMatchingStrategy	api_schema_field	Location Matching Strategy	DeveloperMetadataLookup.locationMatchingStrategy (string)	Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting loca…
DataFilter.developerMetadataLookup.metadataLocation	api_schema_field	Metadata Location	DeveloperMetadataLookup.metadataLocation (object)	Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
DataFilter.developerMetadataLookup.metadataLocation.locationType	api_schema_field	Location Type	DeveloperMetadataLocation.locationType (string)	The type of location this object represents. This field is read-only.
DataFilter.developerMetadataLookup.metadataLocation.sheetId	api_schema_field	Sheet Id	DeveloperMetadataLocation.sheetId (integer)	The ID of the sheet when metadata is associated with an entire sheet.
DataFilter.developerMetadataLookup.metadataLocation.dimensionRange	api_schema_field	Dimension Range	DeveloperMetadataLocation.dimensionRange (object)	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
DataFilter.developerMetadataLookup.metadataLocation.dimensionRange.sheetId	api_schema_field	Sheet Id	DimensionRange.sheetId (integer)	The sheet this span is on.
DataFilter.developerMetadataLookup.metadataLocation.dimensionRange.startIndex	api_schema_field	Start Index	DimensionRange.startIndex (integer)	The start (inclusive) of the span, or not set if unbounded.
DataFilter.developerMetadataLookup.metadataLocation.dimensionRange.dimension	api_schema_field	Dimension	DimensionRange.dimension (string)	The dimension of the span.
DataFilter.developerMetadataLookup.metadataLocation.dimensionRange.endIndex	api_schema_field	End Index	DimensionRange.endIndex (integer)	The end (exclusive) of the span, or not set if unbounded.
DataFilter.developerMetadataLookup.metadataLocation.spreadsheet	api_schema_field	Spreadsheet	DeveloperMetadataLocation.spreadsheet (boolean)	True when metadata is associated with an entire spreadsheet.
DataFilter.developerMetadataLookup.visibility	api_schema_field	Visibility	DeveloperMetadataLookup.visibility (string)	Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visible to the requesting project is considered.
DataFilter.a1Range	api_schema_field	A1 Range	DataFilter.a1Range (string)	Selects data that matches the specified A1 range.
DataFilter.gridRange	api_schema_field	Grid Range	DataFilter.gridRange (object)	Selects data that matches the range described by the GridRange.
DataFilter.gridRange.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
DataFilter.gridRange.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
DataFilter.gridRange.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
DataFilter.gridRange.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
DataFilter.gridRange.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
CellData.chipRuns	api_schema_field	Chip Runs	CellData.chipRuns (array)	Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty Chip. When…
CellData.chipRuns.chip	api_schema_field	Chip	ChipRun.chip (object)	Optional. The chip of this run.
CellData.chipRuns.chip.richLinkProperties	api_schema_field	Rich Link Properties	Chip.richLinkProperties (object)	Properties of a rich link.
CellData.chipRuns.chip.richLinkProperties.mimeType	api_schema_field	Mime Type	RichLinkProperties.mimeType (string)	Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive).
CellData.chipRuns.chip.richLinkProperties.uri	api_schema_field	Uri	RichLinkProperties.uri (string)	Required. The URI to the link. This is always present.
CellData.chipRuns.chip.personProperties	api_schema_field	Person Properties	Chip.personProperties (object)	Properties of a linked person.
CellData.chipRuns.chip.personProperties.displayFormat	api_schema_field	Display Format	PersonProperties.displayFormat (string)	Optional. The display format of the person chip. If not set, the default display format is used.
CellData.chipRuns.chip.personProperties.email	schema_pii_or_identity_field	Email	PersonProperties.email (string)	Required. The email address linked to this person. This field is always present.
CellData.chipRuns.startIndex	api_schema_field	Start Index	ChipRun.startIndex (integer)	Required. The zero-based character index where this run starts, in UTF-16 code units.
CellData.dataValidation	api_schema_field	Data Validation	CellData.dataValidation (object)	A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule.
CellData.dataValidation.showCustomUi	api_schema_field	Show Custom Ui	DataValidationRule.showCustomUi (boolean)	True if the UI should be customized based on the kind of condition. If true, "List" conditions will show a dropdown.
CellData.dataValidation.strict	api_schema_field	Strict	DataValidationRule.strict (boolean)	True if invalid data should be rejected.
CellData.dataValidation.condition	api_schema_field	Condition	DataValidationRule.condition (object)	The condition that data in the cell must match.
CellData.dataValidation.condition.type	api_schema_field	Type	BooleanCondition.type (string)	The type of condition.
CellData.dataValidation.condition.values	api_schema_field	Values	BooleanCondition.values (array)	The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
CellData.dataValidation.condition.values.userEnteredValue	api_schema_field	User Entered Value	ConditionValue.userEnteredValue (string)	A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+').
CellData.dataValidation.condition.values.relativeDate	api_schema_field	Relative Date	ConditionValue.relativeDate (string)	A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filte…
CellData.dataValidation.inputMessage	api_schema_field	Input Message	DataValidationRule.inputMessage (string)	A message to show the user when adding data to the cell.
CellData.dataSourceTable	api_schema_field	Data Source Table	CellData.dataSourceTable (object)	A data source table anchored at this cell. The size of data source table itself is computed dynamically based on its configuration. Only the first cell of the data source table contains the data source table definition. The other cells will contain the displa…
CellData.dataSourceTable.columnSelectionType	api_schema_field	Column Selection Type	DataSourceTable.columnSelectionType (string)	The type to select columns for the data source table. Defaults to SELECTED.
CellData.dataSourceTable.filterSpecs	api_schema_field	Filter Specs	DataSourceTable.filterSpecs (array)	Filter specifications in the data source table.
CellData.dataSourceTable.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
CellData.dataSourceTable.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.dataSourceTable.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
CellData.dataSourceTable.filterSpecs.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
CellData.dataSourceTable.filterSpecs.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
CellData.dataSourceTable.filterSpecs.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
CellData.dataSourceTable.filterSpecs.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
CellData.dataSourceTable.filterSpecs.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
CellData.dataSourceTable.filterSpecs.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
CellData.dataSourceTable.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
CellData.dataSourceTable.rowLimit	api_schema_field	Row Limit	DataSourceTable.rowLimit (integer)	The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.
CellData.dataSourceTable.dataSourceId	api_schema_field	Data Source Id	DataSourceTable.dataSourceId (string)	The ID of the data source the data source table is associated with.
CellData.dataSourceTable.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceTable.dataExecutionStatus (object)	Output only. The data execution status.
CellData.dataSourceTable.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
CellData.dataSourceTable.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
CellData.dataSourceTable.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
CellData.dataSourceTable.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
CellData.dataSourceTable.sortSpecs	api_schema_field	Sort Specs	DataSourceTable.sortSpecs (array)	Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.
CellData.dataSourceTable.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
CellData.dataSourceTable.sortSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.dataSourceTable.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
CellData.dataSourceTable.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
CellData.dataSourceTable.sortSpecs.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.dataSourceTable.sortSpecs.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.dataSourceTable.sortSpecs.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.dataSourceTable.sortSpecs.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.dataSourceTable.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
CellData.dataSourceTable.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
CellData.dataSourceTable.sortSpecs.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.dataSourceTable.sortSpecs.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.dataSourceTable.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
CellData.dataSourceTable.sortSpecs.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.dataSourceTable.sortSpecs.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.dataSourceTable.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
CellData.dataSourceTable.sortSpecs.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.dataSourceTable.sortSpecs.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.dataSourceTable.sortSpecs.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.dataSourceTable.sortSpecs.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.dataSourceTable.columns	api_schema_field	Columns	DataSourceTable.columns (array)	Columns selected for the data source table. The column_selection_type must be SELECTED.
CellData.dataSourceTable.columns.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.effectiveValue	api_schema_field	Effective Value	CellData.effectiveValue (object)	The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only.
CellData.effectiveValue.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
CellData.effectiveValue.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
CellData.effectiveValue.errorValue.type	api_schema_field	Type	ErrorValue.type (string)	The type of error.
CellData.effectiveValue.errorValue.message	api_schema_field	Message	ErrorValue.message (string)	A message with more information about the error (in the spreadsheet's locale).
CellData.effectiveValue.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
CellData.effectiveValue.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
CellData.effectiveValue.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
CellData.note	api_schema_field	Note	CellData.note (string)	Any note on the cell.
CellData.textFormatRuns	api_schema_field	Text Format Runs	CellData.textFormatRuns (array)	Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of…
CellData.textFormatRuns.format	api_schema_field	Format	TextFormatRun.format (object)	The format of this run. Absent values inherit the cell's format.
CellData.textFormatRuns.format.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
CellData.textFormatRuns.format.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.textFormatRuns.format.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.textFormatRuns.format.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
CellData.textFormatRuns.format.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.textFormatRuns.format.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.textFormatRuns.format.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.textFormatRuns.format.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.textFormatRuns.format.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
CellData.textFormatRuns.format.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
CellData.textFormatRuns.format.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
CellData.textFormatRuns.format.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
CellData.textFormatRuns.format.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
CellData.textFormatRuns.format.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
CellData.textFormatRuns.format.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
CellData.textFormatRuns.format.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
CellData.textFormatRuns.startIndex	api_schema_field	Start Index	TextFormatRun.startIndex (integer)	The zero-based character index where this run starts, in UTF-16 code units.
CellData.pivotTable	api_schema_field	Pivot Table	CellData.pivotTable (object)	A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calc…
CellData.pivotTable.filterSpecs	api_schema_field	Filter Specs	PivotTable.filterSpecs (array)	The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
CellData.pivotTable.filterSpecs.columnOffsetIndex	api_schema_field	Column Offset Index	PivotFilterSpec.columnOffsetIndex (integer)	The zero-based column offset of the source range.
CellData.pivotTable.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	PivotFilterSpec.filterCriteria (object)	The criteria for the column.
CellData.pivotTable.filterSpecs.filterCriteria.condition	api_schema_field	Condition	PivotFilterCriteria.condition (object)	A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relativ…
CellData.pivotTable.filterSpecs.filterCriteria.visibleByDefault	api_schema_field	Visible By Default	PivotFilterCriteria.visibleByDefault (boolean)	Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.
CellData.pivotTable.filterSpecs.filterCriteria.visibleValues	api_schema_field	Visible Values	PivotFilterCriteria.visibleValues (array)	Values that should be included. Values not listed here are excluded.
CellData.pivotTable.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotFilterSpec.dataSourceColumnReference (object)	The reference to the data source column.
CellData.pivotTable.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.pivotTable.dataSourceId	api_schema_field	Data Source Id	PivotTable.dataSourceId (string)	The ID of the data source the pivot table is reading data from.
CellData.pivotTable.criteria	api_schema_field	Criteria	PivotTable.criteria (object)	An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For e…
CellData.pivotTable.rows	api_schema_field	Rows	PivotTable.rows (array)	Each row grouping in the pivot table.
CellData.pivotTable.rows.sourceColumnOffset	api_schema_field	Source Column Offset	PivotGroup.sourceColumnOffset (integer)	The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
CellData.pivotTable.rows.groupLimit	api_schema_field	Group Limit	PivotGroup.groupLimit (object)	The count limit on rows or columns to apply to this pivot group.
CellData.pivotTable.rows.groupLimit.countLimit	api_schema_field	Count Limit	PivotGroupLimit.countLimit (integer)	The count limit.
CellData.pivotTable.rows.groupLimit.applyOrder	api_schema_field	Apply Order	PivotGroupLimit.applyOrder (integer)	The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all piv…
CellData.pivotTable.rows.label	api_schema_field	Label	PivotGroup.label (string)	The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables creat…
CellData.pivotTable.rows.valueMetadata	api_schema_field	Value Metadata	PivotGroup.valueMetadata (array)	Metadata about values in the grouping.
CellData.pivotTable.rows.valueMetadata.collapsed	api_schema_field	Collapsed	PivotGroupValueMetadata.collapsed (boolean)	True if the data corresponding to the value is collapsed.
CellData.pivotTable.rows.valueMetadata.value	api_schema_field	Value	PivotGroupValueMetadata.value (object)	The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)
CellData.pivotTable.rows.valueBucket	api_schema_field	Value Bucket	PivotGroup.valueBucket (object)	The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
CellData.pivotTable.rows.valueBucket.valuesIndex	api_schema_field	Values Index	PivotGroupSortValueBucket.valuesIndex (integer)	The offset in the PivotTable.values list which the values in this grouping should be sorted by.
CellData.pivotTable.rows.valueBucket.buckets	api_schema_field	Buckets	PivotGroupSortValueBucket.buckets (array)	Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second val…
CellData.pivotTable.rows.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotGroup.dataSourceColumnReference (object)	The reference to the data source column this grouping is based on.
CellData.pivotTable.rows.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.pivotTable.rows.sortOrder	api_schema_field	Sort Order	PivotGroup.sortOrder (string)	The order the values in this group should be sorted.
CellData.pivotTable.rows.repeatHeadings	api_schema_field	Repeat Headings	PivotGroup.repeatHeadings (boolean)	True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though…
CellData.pivotTable.rows.showTotals	api_schema_field	Show Totals	PivotGroup.showTotals (boolean)	True if the pivot table should include the totals for this grouping.
CellData.pivotTable.rows.groupRule	api_schema_field	Group Rule	PivotGroup.groupRule (object)	The group rule to apply to this row/column group.
CellData.pivotTable.rows.groupRule.histogramRule	api_schema_field	Histogram Rule	PivotGroupRule.histogramRule (object)	A HistogramRule.
CellData.pivotTable.rows.groupRule.dateTimeRule	api_schema_field	Date Time Rule	PivotGroupRule.dateTimeRule (object)	A DateTimeRule.
CellData.pivotTable.rows.groupRule.manualRule	api_schema_field	Manual Rule	PivotGroupRule.manualRule (object)	A ManualRule.
CellData.pivotTable.valueLayout	api_schema_field	Value Layout	PivotTable.valueLayout (string)	Whether values should be listed horizontally (as columns) or vertically (as rows).
CellData.pivotTable.columns	api_schema_field	Columns	PivotTable.columns (array)	Each column grouping in the pivot table.
CellData.pivotTable.columns.sourceColumnOffset	api_schema_field	Source Column Offset	PivotGroup.sourceColumnOffset (integer)	The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
CellData.pivotTable.columns.groupLimit	api_schema_field	Group Limit	PivotGroup.groupLimit (object)	The count limit on rows or columns to apply to this pivot group.
CellData.pivotTable.columns.groupLimit.countLimit	api_schema_field	Count Limit	PivotGroupLimit.countLimit (integer)	The count limit.
CellData.pivotTable.columns.groupLimit.applyOrder	api_schema_field	Apply Order	PivotGroupLimit.applyOrder (integer)	The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all piv…
CellData.pivotTable.columns.label	api_schema_field	Label	PivotGroup.label (string)	The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables creat…
CellData.pivotTable.columns.valueMetadata	api_schema_field	Value Metadata	PivotGroup.valueMetadata (array)	Metadata about values in the grouping.
CellData.pivotTable.columns.valueMetadata.collapsed	api_schema_field	Collapsed	PivotGroupValueMetadata.collapsed (boolean)	True if the data corresponding to the value is collapsed.
CellData.pivotTable.columns.valueMetadata.value	api_schema_field	Value	PivotGroupValueMetadata.value (object)	The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)
CellData.pivotTable.columns.valueBucket	api_schema_field	Value Bucket	PivotGroup.valueBucket (object)	The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
CellData.pivotTable.columns.valueBucket.valuesIndex	api_schema_field	Values Index	PivotGroupSortValueBucket.valuesIndex (integer)	The offset in the PivotTable.values list which the values in this grouping should be sorted by.
CellData.pivotTable.columns.valueBucket.buckets	api_schema_field	Buckets	PivotGroupSortValueBucket.buckets (array)	Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second val…
CellData.pivotTable.columns.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotGroup.dataSourceColumnReference (object)	The reference to the data source column this grouping is based on.
CellData.pivotTable.columns.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.pivotTable.columns.sortOrder	api_schema_field	Sort Order	PivotGroup.sortOrder (string)	The order the values in this group should be sorted.
CellData.pivotTable.columns.repeatHeadings	api_schema_field	Repeat Headings	PivotGroup.repeatHeadings (boolean)	True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though…
CellData.pivotTable.columns.showTotals	api_schema_field	Show Totals	PivotGroup.showTotals (boolean)	True if the pivot table should include the totals for this grouping.
CellData.pivotTable.columns.groupRule	api_schema_field	Group Rule	PivotGroup.groupRule (object)	The group rule to apply to this row/column group.
CellData.pivotTable.columns.groupRule.histogramRule	api_schema_field	Histogram Rule	PivotGroupRule.histogramRule (object)	A HistogramRule.
CellData.pivotTable.columns.groupRule.dateTimeRule	api_schema_field	Date Time Rule	PivotGroupRule.dateTimeRule (object)	A DateTimeRule.
CellData.pivotTable.columns.groupRule.manualRule	api_schema_field	Manual Rule	PivotGroupRule.manualRule (object)	A ManualRule.
CellData.pivotTable.source	api_schema_field	Source	PivotTable.source (object)	The range the pivot table is reading data from.
CellData.pivotTable.source.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
CellData.pivotTable.source.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
CellData.pivotTable.source.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
CellData.pivotTable.source.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
CellData.pivotTable.source.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
CellData.pivotTable.values	api_schema_field	Values	PivotTable.values (array)	A list of values to include in the pivot table.
CellData.pivotTable.values.name	schema_pii_or_identity_field	Name	PivotValue.name (string)	A name to use for the value.
CellData.pivotTable.values.calculatedDisplayType	api_schema_field	Calculated Display Type	PivotValue.calculatedDisplayType (string)	If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the…
CellData.pivotTable.values.formula	api_schema_field	Formula	PivotValue.formula (string)	A custom formula to calculate the value. The formula must start with an `=` character.
CellData.pivotTable.values.sourceColumnOffset	api_schema_field	Source Column Offset	PivotValue.sourceColumnOffset (integer)	The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.
CellData.pivotTable.values.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotValue.dataSourceColumnReference (object)	The reference to the data source column that this value reads from.
CellData.pivotTable.values.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
CellData.pivotTable.values.summarizeFunction	api_schema_field	Summarize Function	PivotValue.summarizeFunction (string)	A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
CellData.pivotTable.dataExecutionStatus	api_schema_field	Data Execution Status	PivotTable.dataExecutionStatus (object)	Output only. The data execution status for data source pivot tables.
CellData.pivotTable.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
CellData.pivotTable.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
CellData.pivotTable.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
CellData.pivotTable.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
CellData.hyperlink	api_schema_field	Hyperlink	CellData.hyperlink (string)	A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the…
CellData.userEnteredValue	api_schema_field	User Entered Value	CellData.userEnteredValue (object)	The value the user entered in the cell. e.g., `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format.
CellData.userEnteredValue.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
CellData.userEnteredValue.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
CellData.userEnteredValue.errorValue.type	api_schema_field	Type	ErrorValue.type (string)	The type of error.
CellData.userEnteredValue.errorValue.message	api_schema_field	Message	ErrorValue.message (string)	A message with more information about the error (in the spreadsheet's locale).
CellData.userEnteredValue.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
CellData.userEnteredValue.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
CellData.userEnteredValue.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
CellData.formattedValue	api_schema_field	Formatted Value	CellData.formattedValue (string)	The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.
CellData.effectiveFormat	api_schema_field	Effective Format	CellData.effectiveFormat (object)	The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written.…
CellData.effectiveFormat.numberFormat	api_schema_field	Number Format	CellFormat.numberFormat (object)	A format describing how number values should be represented to the user.
CellData.effectiveFormat.numberFormat.type	api_schema_field	Type	NumberFormat.type (string)	The type of the number format. When writing, this field must be set.
CellData.effectiveFormat.numberFormat.pattern	api_schema_field	Pattern	NumberFormat.pattern (string)	Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for mo…
CellData.effectiveFormat.textFormat	api_schema_field	Text Format	CellFormat.textFormat (object)	The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
CellData.effectiveFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
CellData.effectiveFormat.textFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.effectiveFormat.textFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.effectiveFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
CellData.effectiveFormat.textFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.effectiveFormat.textFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.effectiveFormat.textFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.effectiveFormat.textFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.effectiveFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
CellData.effectiveFormat.textFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
CellData.effectiveFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
CellData.effectiveFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
CellData.effectiveFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
CellData.effectiveFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
CellData.effectiveFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
CellData.effectiveFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
CellData.effectiveFormat.textRotation	api_schema_field	Text Rotation	CellFormat.textRotation (object)	The rotation applied to text in the cell.
CellData.effectiveFormat.textRotation.angle	api_schema_field	Angle	TextRotation.angle (integer)	The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counte…
CellData.effectiveFormat.textRotation.vertical	api_schema_field	Vertical	TextRotation.vertical (boolean)	If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: \| V \| \| e \| \| r \| \| t \| \| i \| \| c \| \| a \| \| l \|
CellData.effectiveFormat.verticalAlignment	api_schema_field	Vertical Alignment	CellFormat.verticalAlignment (string)	The vertical alignment of the value in the cell.
CellData.effectiveFormat.backgroundColorStyle	api_schema_field	Background Color Style	CellFormat.backgroundColorStyle (object)	The background color of the cell. If background_color is also set, this field takes precedence.
CellData.effectiveFormat.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.effectiveFormat.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.effectiveFormat.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.effectiveFormat.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.effectiveFormat.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.effectiveFormat.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.effectiveFormat.textDirection	api_schema_field	Text Direction	CellFormat.textDirection (string)	The direction of the text in the cell.
CellData.effectiveFormat.wrapStrategy	api_schema_field	Wrap Strategy	CellFormat.wrapStrategy (string)	The wrap strategy for the value in the cell.
CellData.effectiveFormat.backgroundColor	api_schema_field	Background Color	CellFormat.backgroundColor (object)	The background color of the cell. Deprecated: Use background_color_style.
CellData.effectiveFormat.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.effectiveFormat.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.effectiveFormat.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.effectiveFormat.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.effectiveFormat.borders	api_schema_field	Borders	CellFormat.borders (object)	The borders of the cell.
CellData.effectiveFormat.borders.top	api_schema_field	Top	Borders.top (object)	The top border of the cell.
CellData.effectiveFormat.borders.top.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.effectiveFormat.borders.top.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.effectiveFormat.borders.top.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.effectiveFormat.borders.top.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.effectiveFormat.borders.bottom	api_schema_field	Bottom	Borders.bottom (object)	The bottom border of the cell.
CellData.effectiveFormat.borders.bottom.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.effectiveFormat.borders.bottom.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.effectiveFormat.borders.bottom.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.effectiveFormat.borders.bottom.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.effectiveFormat.borders.right	api_schema_field	Right	Borders.right (object)	The right border of the cell.
CellData.effectiveFormat.borders.right.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.effectiveFormat.borders.right.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.effectiveFormat.borders.right.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.effectiveFormat.borders.right.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.effectiveFormat.borders.left	api_schema_field	Left	Borders.left (object)	The left border of the cell.
CellData.effectiveFormat.borders.left.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.effectiveFormat.borders.left.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.effectiveFormat.borders.left.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.effectiveFormat.borders.left.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.effectiveFormat.padding	api_schema_field	Padding	CellFormat.padding (object)	The padding of the cell.
CellData.effectiveFormat.padding.left	api_schema_field	Left	Padding.left (integer)	The left padding of the cell.
CellData.effectiveFormat.padding.right	api_schema_field	Right	Padding.right (integer)	The right padding of the cell.
CellData.effectiveFormat.padding.top	api_schema_field	Top	Padding.top (integer)	The top padding of the cell.
CellData.effectiveFormat.padding.bottom	api_schema_field	Bottom	Padding.bottom (integer)	The bottom padding of the cell.
CellData.effectiveFormat.hyperlinkDisplayType	api_schema_field	Hyperlink Display Type	CellFormat.hyperlinkDisplayType (string)	If one exists, how a hyperlink should be displayed in the cell.
CellData.effectiveFormat.horizontalAlignment	api_schema_field	Horizontal Alignment	CellFormat.horizontalAlignment (string)	The horizontal alignment of the value in the cell.
CellData.userEnteredFormat	api_schema_field	User Entered Format	CellData.userEnteredFormat (object)	The format the user entered for the cell. When writing, the new format will be merged with the existing format.
CellData.userEnteredFormat.numberFormat	api_schema_field	Number Format	CellFormat.numberFormat (object)	A format describing how number values should be represented to the user.
CellData.userEnteredFormat.numberFormat.type	api_schema_field	Type	NumberFormat.type (string)	The type of the number format. When writing, this field must be set.
CellData.userEnteredFormat.numberFormat.pattern	api_schema_field	Pattern	NumberFormat.pattern (string)	Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for mo…
CellData.userEnteredFormat.textFormat	api_schema_field	Text Format	CellFormat.textFormat (object)	The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.
CellData.userEnteredFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
CellData.userEnteredFormat.textFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.userEnteredFormat.textFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.userEnteredFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
CellData.userEnteredFormat.textFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.textFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.textFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.userEnteredFormat.textFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
CellData.userEnteredFormat.textFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
CellData.userEnteredFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
CellData.userEnteredFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
CellData.userEnteredFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
CellData.userEnteredFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
CellData.userEnteredFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
CellData.userEnteredFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
CellData.userEnteredFormat.textRotation	api_schema_field	Text Rotation	CellFormat.textRotation (object)	The rotation applied to text in the cell.
CellData.userEnteredFormat.textRotation.angle	api_schema_field	Angle	TextRotation.angle (integer)	The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counte…
CellData.userEnteredFormat.textRotation.vertical	api_schema_field	Vertical	TextRotation.vertical (boolean)	If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: \| V \| \| e \| \| r \| \| t \| \| i \| \| c \| \| a \| \| l \|
CellData.userEnteredFormat.verticalAlignment	api_schema_field	Vertical Alignment	CellFormat.verticalAlignment (string)	The vertical alignment of the value in the cell.
CellData.userEnteredFormat.backgroundColorStyle	api_schema_field	Background Color Style	CellFormat.backgroundColorStyle (object)	The background color of the cell. If background_color is also set, this field takes precedence.
CellData.userEnteredFormat.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
CellData.userEnteredFormat.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.userEnteredFormat.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
CellData.userEnteredFormat.textDirection	api_schema_field	Text Direction	CellFormat.textDirection (string)	The direction of the text in the cell.
CellData.userEnteredFormat.wrapStrategy	api_schema_field	Wrap Strategy	CellFormat.wrapStrategy (string)	The wrap strategy for the value in the cell.
CellData.userEnteredFormat.backgroundColor	api_schema_field	Background Color	CellFormat.backgroundColor (object)	The background color of the cell. Deprecated: Use background_color_style.
CellData.userEnteredFormat.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
CellData.userEnteredFormat.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
CellData.userEnteredFormat.borders	api_schema_field	Borders	CellFormat.borders (object)	The borders of the cell.
CellData.userEnteredFormat.borders.top	api_schema_field	Top	Borders.top (object)	The top border of the cell.
CellData.userEnteredFormat.borders.top.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.userEnteredFormat.borders.top.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.userEnteredFormat.borders.top.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.userEnteredFormat.borders.top.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.userEnteredFormat.borders.bottom	api_schema_field	Bottom	Borders.bottom (object)	The bottom border of the cell.
CellData.userEnteredFormat.borders.bottom.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.userEnteredFormat.borders.bottom.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.userEnteredFormat.borders.bottom.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.userEnteredFormat.borders.bottom.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.userEnteredFormat.borders.right	api_schema_field	Right	Borders.right (object)	The right border of the cell.
CellData.userEnteredFormat.borders.right.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.userEnteredFormat.borders.right.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.userEnteredFormat.borders.right.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.userEnteredFormat.borders.right.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.userEnteredFormat.borders.left	api_schema_field	Left	Borders.left (object)	The left border of the cell.
CellData.userEnteredFormat.borders.left.width	api_schema_field	Width	Border.width (integer)	The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
CellData.userEnteredFormat.borders.left.style	api_schema_field	Style	Border.style (string)	The style of the border.
CellData.userEnteredFormat.borders.left.color	api_schema_field	Color	Border.color (object)	The color of the border. Deprecated: Use color_style.
CellData.userEnteredFormat.borders.left.colorStyle	api_schema_field	Color Style	Border.colorStyle (object)	The color of the border. If color is also set, this field takes precedence.
CellData.userEnteredFormat.padding	api_schema_field	Padding	CellFormat.padding (object)	The padding of the cell.
CellData.userEnteredFormat.padding.left	api_schema_field	Left	Padding.left (integer)	The left padding of the cell.
CellData.userEnteredFormat.padding.right	api_schema_field	Right	Padding.right (integer)	The right padding of the cell.
CellData.userEnteredFormat.padding.top	api_schema_field	Top	Padding.top (integer)	The top padding of the cell.
CellData.userEnteredFormat.padding.bottom	api_schema_field	Bottom	Padding.bottom (integer)	The bottom padding of the cell.
CellData.userEnteredFormat.hyperlinkDisplayType	api_schema_field	Hyperlink Display Type	CellFormat.hyperlinkDisplayType (string)	If one exists, how a hyperlink should be displayed in the cell.
CellData.userEnteredFormat.horizontalAlignment	api_schema_field	Horizontal Alignment	CellFormat.horizontalAlignment (string)	The horizontal alignment of the value in the cell.
CellData.dataSourceFormula	api_schema_field	Data Source Formula	CellData.dataSourceFormula (object)	Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`.
CellData.dataSourceFormula.dataSourceId	api_schema_field	Data Source Id	DataSourceFormula.dataSourceId (string)	The ID of the data source the formula is associated with.
CellData.dataSourceFormula.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceFormula.dataExecutionStatus (object)	Output only. The data execution status.
CellData.dataSourceFormula.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
CellData.dataSourceFormula.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
CellData.dataSourceFormula.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
CellData.dataSourceFormula.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
ExtendedValue.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
ExtendedValue.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
ExtendedValue.errorValue.type	api_schema_field	Type	ErrorValue.type (string)	The type of error.
ExtendedValue.errorValue.message	api_schema_field	Message	ErrorValue.message (string)	A message with more information about the error (in the spreadsheet's locale).
ExtendedValue.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
ExtendedValue.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
ExtendedValue.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
TextFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
TextFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
TextFormat.foregroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
TextFormat.foregroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
TextFormat.foregroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
TextFormat.foregroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
TextFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
TextFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
TextFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
TextFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
TextFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
TextFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
TextFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
TextFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
TextFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
TextFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
TextFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
TextFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
TextFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
TextFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
NumberFormat.type	api_schema_field	Type	NumberFormat.type (string)	The type of the number format. When writing, this field must be set.
NumberFormat.pattern	api_schema_field	Pattern	NumberFormat.pattern (string)	Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for mo…
BasicFilter.sortSpecs	api_schema_field	Sort Specs	BasicFilter.sortSpecs (array)	The sort order per column. Later specifications are used when values are equal in the earlier specifications.
BasicFilter.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
BasicFilter.sortSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
BasicFilter.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
BasicFilter.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
BasicFilter.sortSpecs.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.sortSpecs.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
BasicFilter.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
BasicFilter.sortSpecs.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
BasicFilter.sortSpecs.foregroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.foregroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.foregroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.sortSpecs.foregroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
BasicFilter.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
BasicFilter.sortSpecs.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
BasicFilter.sortSpecs.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.sortSpecs.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
BasicFilter.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
BasicFilter.sortSpecs.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.sortSpecs.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.sortSpecs.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs	api_schema_field	Filter Specs	BasicFilter.filterSpecs (array)	The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
BasicFilter.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
BasicFilter.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
BasicFilter.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
BasicFilter.filterSpecs.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
BasicFilter.filterSpecs.filterCriteria.visibleForegroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
BasicFilter.filterSpecs.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
BasicFilter.filterSpecs.filterCriteria.condition.type	api_schema_field	Type	BooleanCondition.type (string)	The type of condition.
BasicFilter.filterSpecs.filterCriteria.condition.values	api_schema_field	Values	BooleanCondition.values (array)	The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
BasicFilter.filterSpecs.filterCriteria.visibleBackgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
BasicFilter.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
BasicFilter.range	api_schema_field	Range	BasicFilter.range (object)	The range the filter covers.
BasicFilter.range.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
BasicFilter.range.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
BasicFilter.range.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
BasicFilter.range.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
BasicFilter.range.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
BasicFilter.tableId	api_schema_field	Table Id	BasicFilter.tableId (string)	The table this filter is backed by, if any. When writing, only one of range or table_id may be set.
BasicFilter.criteria	api_schema_field	Criteria	BasicFilter.criteria (object)	The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.
PivotTable.filterSpecs	api_schema_field	Filter Specs	PivotTable.filterSpecs (array)	The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.
PivotTable.filterSpecs.columnOffsetIndex	api_schema_field	Column Offset Index	PivotFilterSpec.columnOffsetIndex (integer)	The zero-based column offset of the source range.
PivotTable.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	PivotFilterSpec.filterCriteria (object)	The criteria for the column.
PivotTable.filterSpecs.filterCriteria.condition	api_schema_field	Condition	PivotFilterCriteria.condition (object)	A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relativ…
PivotTable.filterSpecs.filterCriteria.condition.type	api_schema_field	Type	BooleanCondition.type (string)	The type of condition.
PivotTable.filterSpecs.filterCriteria.condition.values	api_schema_field	Values	BooleanCondition.values (array)	The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
PivotTable.filterSpecs.filterCriteria.visibleByDefault	api_schema_field	Visible By Default	PivotFilterCriteria.visibleByDefault (boolean)	Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.
PivotTable.filterSpecs.filterCriteria.visibleValues	api_schema_field	Visible Values	PivotFilterCriteria.visibleValues (array)	Values that should be included. Values not listed here are excluded.
PivotTable.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotFilterSpec.dataSourceColumnReference (object)	The reference to the data source column.
PivotTable.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
PivotTable.dataSourceId	api_schema_field	Data Source Id	PivotTable.dataSourceId (string)	The ID of the data source the pivot table is reading data from.
PivotTable.criteria	api_schema_field	Criteria	PivotTable.criteria (object)	An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For e…
PivotTable.rows	api_schema_field	Rows	PivotTable.rows (array)	Each row grouping in the pivot table.
PivotTable.rows.sourceColumnOffset	api_schema_field	Source Column Offset	PivotGroup.sourceColumnOffset (integer)	The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
PivotTable.rows.groupLimit	api_schema_field	Group Limit	PivotGroup.groupLimit (object)	The count limit on rows or columns to apply to this pivot group.
PivotTable.rows.groupLimit.countLimit	api_schema_field	Count Limit	PivotGroupLimit.countLimit (integer)	The count limit.
PivotTable.rows.groupLimit.applyOrder	api_schema_field	Apply Order	PivotGroupLimit.applyOrder (integer)	The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all piv…
PivotTable.rows.label	api_schema_field	Label	PivotGroup.label (string)	The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables creat…
PivotTable.rows.valueMetadata	api_schema_field	Value Metadata	PivotGroup.valueMetadata (array)	Metadata about values in the grouping.
PivotTable.rows.valueMetadata.collapsed	api_schema_field	Collapsed	PivotGroupValueMetadata.collapsed (boolean)	True if the data corresponding to the value is collapsed.
PivotTable.rows.valueMetadata.value	api_schema_field	Value	PivotGroupValueMetadata.value (object)	The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)
PivotTable.rows.valueMetadata.value.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
PivotTable.rows.valueMetadata.value.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
PivotTable.rows.valueMetadata.value.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
PivotTable.rows.valueMetadata.value.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
PivotTable.rows.valueMetadata.value.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
PivotTable.rows.valueBucket	api_schema_field	Value Bucket	PivotGroup.valueBucket (object)	The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
PivotTable.rows.valueBucket.valuesIndex	api_schema_field	Values Index	PivotGroupSortValueBucket.valuesIndex (integer)	The offset in the PivotTable.values list which the values in this grouping should be sorted by.
PivotTable.rows.valueBucket.buckets	api_schema_field	Buckets	PivotGroupSortValueBucket.buckets (array)	Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second val…
PivotTable.rows.valueBucket.buckets.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
PivotTable.rows.valueBucket.buckets.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
PivotTable.rows.valueBucket.buckets.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
PivotTable.rows.valueBucket.buckets.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
PivotTable.rows.valueBucket.buckets.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
PivotTable.rows.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotGroup.dataSourceColumnReference (object)	The reference to the data source column this grouping is based on.
PivotTable.rows.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
PivotTable.rows.sortOrder	api_schema_field	Sort Order	PivotGroup.sortOrder (string)	The order the values in this group should be sorted.
PivotTable.rows.repeatHeadings	api_schema_field	Repeat Headings	PivotGroup.repeatHeadings (boolean)	True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though…
PivotTable.rows.showTotals	api_schema_field	Show Totals	PivotGroup.showTotals (boolean)	True if the pivot table should include the totals for this grouping.
PivotTable.rows.groupRule	api_schema_field	Group Rule	PivotGroup.groupRule (object)	The group rule to apply to this row/column group.
PivotTable.rows.groupRule.histogramRule	api_schema_field	Histogram Rule	PivotGroupRule.histogramRule (object)	A HistogramRule.
PivotTable.rows.groupRule.histogramRule.start	api_schema_field	Start	HistogramRule.start (number)	The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.
PivotTable.rows.groupRule.histogramRule.interval	api_schema_field	Interval	HistogramRule.interval (number)	The size of the buckets that are created. Must be positive.
PivotTable.rows.groupRule.histogramRule.end	api_schema_field	End	HistogramRule.end (number)	The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.
PivotTable.rows.groupRule.dateTimeRule	api_schema_field	Date Time Rule	PivotGroupRule.dateTimeRule (object)	A DateTimeRule.
PivotTable.rows.groupRule.dateTimeRule.type	api_schema_field	Type	DateTimeRule.type (string)	The type of date-time grouping to apply.
PivotTable.rows.groupRule.manualRule	api_schema_field	Manual Rule	PivotGroupRule.manualRule (object)	A ManualRule.
PivotTable.rows.groupRule.manualRule.groups	api_schema_field	Groups	ManualRule.groups (array)	The list of group names and the corresponding items from the source data that map to each group name.
PivotTable.valueLayout	api_schema_field	Value Layout	PivotTable.valueLayout (string)	Whether values should be listed horizontally (as columns) or vertically (as rows).
PivotTable.columns	api_schema_field	Columns	PivotTable.columns (array)	Each column grouping in the pivot table.
PivotTable.columns.sourceColumnOffset	api_schema_field	Source Column Offset	PivotGroup.sourceColumnOffset (integer)	The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
PivotTable.columns.groupLimit	api_schema_field	Group Limit	PivotGroup.groupLimit (object)	The count limit on rows or columns to apply to this pivot group.
PivotTable.columns.groupLimit.countLimit	api_schema_field	Count Limit	PivotGroupLimit.countLimit (integer)	The count limit.
PivotTable.columns.groupLimit.applyOrder	api_schema_field	Apply Order	PivotGroupLimit.applyOrder (integer)	The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all piv…
PivotTable.columns.label	api_schema_field	Label	PivotGroup.label (string)	The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables creat…
PivotTable.columns.valueMetadata	api_schema_field	Value Metadata	PivotGroup.valueMetadata (array)	Metadata about values in the grouping.
PivotTable.columns.valueMetadata.collapsed	api_schema_field	Collapsed	PivotGroupValueMetadata.collapsed (boolean)	True if the data corresponding to the value is collapsed.
PivotTable.columns.valueMetadata.value	api_schema_field	Value	PivotGroupValueMetadata.value (object)	The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)
PivotTable.columns.valueMetadata.value.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
PivotTable.columns.valueMetadata.value.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
PivotTable.columns.valueMetadata.value.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
PivotTable.columns.valueMetadata.value.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
PivotTable.columns.valueMetadata.value.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
PivotTable.columns.valueBucket	api_schema_field	Value Bucket	PivotGroup.valueBucket (object)	The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
PivotTable.columns.valueBucket.valuesIndex	api_schema_field	Values Index	PivotGroupSortValueBucket.valuesIndex (integer)	The offset in the PivotTable.values list which the values in this grouping should be sorted by.
PivotTable.columns.valueBucket.buckets	api_schema_field	Buckets	PivotGroupSortValueBucket.buckets (array)	Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second val…
PivotTable.columns.valueBucket.buckets.numberValue	api_schema_field	Number Value	ExtendedValue.numberValue (number)	Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.
PivotTable.columns.valueBucket.buckets.errorValue	api_schema_field	Error Value	ExtendedValue.errorValue (object)	Represents an error. This field is read-only.
PivotTable.columns.valueBucket.buckets.stringValue	api_schema_field	String Value	ExtendedValue.stringValue (string)	Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
PivotTable.columns.valueBucket.buckets.formulaValue	api_schema_field	Formula Value	ExtendedValue.formulaValue (string)	Represents a formula.
PivotTable.columns.valueBucket.buckets.boolValue	api_schema_field	Bool Value	ExtendedValue.boolValue (boolean)	Represents a boolean value.
PivotTable.columns.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotGroup.dataSourceColumnReference (object)	The reference to the data source column this grouping is based on.
PivotTable.columns.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
PivotTable.columns.sortOrder	api_schema_field	Sort Order	PivotGroup.sortOrder (string)	The order the values in this group should be sorted.
PivotTable.columns.repeatHeadings	api_schema_field	Repeat Headings	PivotGroup.repeatHeadings (boolean)	True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though…
PivotTable.columns.showTotals	api_schema_field	Show Totals	PivotGroup.showTotals (boolean)	True if the pivot table should include the totals for this grouping.
PivotTable.columns.groupRule	api_schema_field	Group Rule	PivotGroup.groupRule (object)	The group rule to apply to this row/column group.
PivotTable.columns.groupRule.histogramRule	api_schema_field	Histogram Rule	PivotGroupRule.histogramRule (object)	A HistogramRule.
PivotTable.columns.groupRule.histogramRule.start	api_schema_field	Start	HistogramRule.start (number)	The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.
PivotTable.columns.groupRule.histogramRule.interval	api_schema_field	Interval	HistogramRule.interval (number)	The size of the buckets that are created. Must be positive.
PivotTable.columns.groupRule.histogramRule.end	api_schema_field	End	HistogramRule.end (number)	The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.
PivotTable.columns.groupRule.dateTimeRule	api_schema_field	Date Time Rule	PivotGroupRule.dateTimeRule (object)	A DateTimeRule.
PivotTable.columns.groupRule.dateTimeRule.type	api_schema_field	Type	DateTimeRule.type (string)	The type of date-time grouping to apply.
PivotTable.columns.groupRule.manualRule	api_schema_field	Manual Rule	PivotGroupRule.manualRule (object)	A ManualRule.
PivotTable.columns.groupRule.manualRule.groups	api_schema_field	Groups	ManualRule.groups (array)	The list of group names and the corresponding items from the source data that map to each group name.
PivotTable.source	api_schema_field	Source	PivotTable.source (object)	The range the pivot table is reading data from.
PivotTable.source.sheetId	api_schema_field	Sheet Id	GridRange.sheetId (integer)	The sheet this range is on.
PivotTable.source.endColumnIndex	api_schema_field	End Column Index	GridRange.endColumnIndex (integer)	The end column (exclusive) of the range, or not set if unbounded.
PivotTable.source.startRowIndex	api_schema_field	Start Row Index	GridRange.startRowIndex (integer)	The start row (inclusive) of the range, or not set if unbounded.
PivotTable.source.endRowIndex	api_schema_field	End Row Index	GridRange.endRowIndex (integer)	The end row (exclusive) of the range, or not set if unbounded.
PivotTable.source.startColumnIndex	api_schema_field	Start Column Index	GridRange.startColumnIndex (integer)	The start column (inclusive) of the range, or not set if unbounded.
PivotTable.values	api_schema_field	Values	PivotTable.values (array)	A list of values to include in the pivot table.
PivotTable.values.name	schema_pii_or_identity_field	Name	PivotValue.name (string)	A name to use for the value.
PivotTable.values.calculatedDisplayType	api_schema_field	Calculated Display Type	PivotValue.calculatedDisplayType (string)	If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the…
PivotTable.values.formula	api_schema_field	Formula	PivotValue.formula (string)	A custom formula to calculate the value. The formula must start with an `=` character.
PivotTable.values.sourceColumnOffset	api_schema_field	Source Column Offset	PivotValue.sourceColumnOffset (integer)	The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.
PivotTable.values.dataSourceColumnReference	api_schema_field	Data Source Column Reference	PivotValue.dataSourceColumnReference (object)	The reference to the data source column that this value reads from.
PivotTable.values.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
PivotTable.values.summarizeFunction	api_schema_field	Summarize Function	PivotValue.summarizeFunction (string)	A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
PivotTable.dataExecutionStatus	api_schema_field	Data Execution Status	PivotTable.dataExecutionStatus (object)	Output only. The data execution status for data source pivot tables.
PivotTable.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
PivotTable.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
PivotTable.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
PivotTable.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
ChartSpec.hiddenDimensionStrategy	api_schema_field	Hidden Dimension Strategy	ChartSpec.hiddenDimensionStrategy (string)	Determines how the charts will use hidden rows or columns.
ChartSpec.orgChart	api_schema_field	Org Chart	ChartSpec.orgChart (object)	An org chart specification.
ChartSpec.orgChart.nodeSize	api_schema_field	Node Size	OrgChartSpec.nodeSize (string)	The size of the org chart nodes.
ChartSpec.orgChart.selectedNodeColorStyle	api_schema_field	Selected Node Color Style	OrgChartSpec.selectedNodeColorStyle (object)	The color of the selected org chart nodes. If selected_node_color is also set, this field takes precedence.
ChartSpec.orgChart.selectedNodeColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.orgChart.selectedNodeColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.orgChart.selectedNodeColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.orgChart.selectedNodeColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.orgChart.selectedNodeColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.orgChart.selectedNodeColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.orgChart.labels	api_schema_field	Labels	OrgChartSpec.labels (object)	The data containing the labels for all the nodes in the chart. Labels must be unique.
ChartSpec.orgChart.labels.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.orgChart.labels.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.orgChart.labels.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.labels.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.orgChart.labels.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.orgChart.labels.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.labels.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.orgChart.labels.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.orgChart.parentLabels	api_schema_field	Parent Labels	OrgChartSpec.parentLabels (object)	The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional.
ChartSpec.orgChart.parentLabels.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.orgChart.parentLabels.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.orgChart.parentLabels.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.parentLabels.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.orgChart.parentLabels.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.orgChart.parentLabels.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.parentLabels.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.orgChart.parentLabels.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.orgChart.nodeColor	api_schema_field	Node Color	OrgChartSpec.nodeColor (object)	The color of the org chart nodes. Deprecated: Use node_color_style.
ChartSpec.orgChart.nodeColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.orgChart.nodeColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColorStyle	api_schema_field	Node Color Style	OrgChartSpec.nodeColorStyle (object)	The color of the org chart nodes. If node_color is also set, this field takes precedence.
ChartSpec.orgChart.nodeColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.orgChart.nodeColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.orgChart.nodeColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.orgChart.nodeColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.orgChart.selectedNodeColor	api_schema_field	Selected Node Color	OrgChartSpec.selectedNodeColor (object)	The color of the selected org chart nodes. Deprecated: Use selected_node_color_style.
ChartSpec.orgChart.selectedNodeColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.orgChart.selectedNodeColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.orgChart.selectedNodeColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.orgChart.selectedNodeColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.orgChart.tooltips	api_schema_field	Tooltips	OrgChartSpec.tooltips (object)	The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional.
ChartSpec.orgChart.tooltips.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.orgChart.tooltips.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.orgChart.tooltips.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.tooltips.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.orgChart.tooltips.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.orgChart.tooltips.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.orgChart.tooltips.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.orgChart.tooltips.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.title	api_schema_field	Title	ChartSpec.title (string)	The title of the chart.
ChartSpec.titleTextFormat	api_schema_field	Title Text Format	ChartSpec.titleTextFormat (object)	The title text format. Strikethrough, underline, and link are not supported.
ChartSpec.titleTextFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.titleTextFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.titleTextFormat.foregroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.foregroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.foregroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.titleTextFormat.foregroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.titleTextFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.titleTextFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.titleTextFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.titleTextFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.titleTextFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
ChartSpec.titleTextFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.titleTextFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.titleTextFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.titleTextFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.titleTextFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.titleTextFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.maximized	api_schema_field	Maximized	ChartSpec.maximized (boolean)	True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
ChartSpec.dataSourceChartProperties	api_schema_field	Data Source Chart Properties	ChartSpec.dataSourceChartProperties (object)	If present, the field contains data source chart specific properties.
ChartSpec.dataSourceChartProperties.dataSourceId	api_schema_field	Data Source Id	DataSourceChartProperties.dataSourceId (string)	ID of the data source that the chart is associated with.
ChartSpec.dataSourceChartProperties.dataExecutionStatus	api_schema_field	Data Execution Status	DataSourceChartProperties.dataExecutionStatus (object)	Output only. The data execution status.
ChartSpec.dataSourceChartProperties.dataExecutionStatus.state	api_schema_field	State	DataExecutionStatus.state (string)	The state of the data execution.
ChartSpec.dataSourceChartProperties.dataExecutionStatus.errorCode	api_schema_field	Error Code	DataExecutionStatus.errorCode (string)	The error code.
ChartSpec.dataSourceChartProperties.dataExecutionStatus.lastRefreshTime	api_schema_field	Last Refresh Time	DataExecutionStatus.lastRefreshTime (string)	Gets the time the data last successfully refreshed.
ChartSpec.dataSourceChartProperties.dataExecutionStatus.errorMessage	api_schema_field	Error Message	DataExecutionStatus.errorMessage (string)	The error message, which may be empty.
ChartSpec.backgroundColorStyle	api_schema_field	Background Color Style	ChartSpec.backgroundColorStyle (object)	The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
ChartSpec.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.filterSpecs	api_schema_field	Filter Specs	ChartSpec.filterSpecs (array)	The filters applied to the source data of the chart. Only supported for data source charts.
ChartSpec.filterSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	FilterSpec.dataSourceColumnReference (object)	Reference to a data source column.
ChartSpec.filterSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.filterSpecs.filterCriteria	api_schema_field	Filter Criteria	FilterSpec.filterCriteria (object)	The criteria for the column.
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColor	api_schema_field	Visible Background Color	FilterCriteria.visibleBackgroundColor (object)	The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with visible_foreground_color. Deprecated: Use visible_background_color_style.
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColor	api_schema_field	Visible Foreground Color	FilterCriteria.visibleForegroundColor (object)	The foreground color to filter by; only cells with this foreground color are shown. Mutually exclusive with visible_background_color. Deprecated: Use visible_foreground_color_style.
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.filterSpecs.filterCriteria.hiddenValues	api_schema_field	Hidden Values	FilterCriteria.hiddenValues (array)	Values that should be hidden.
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColorStyle	api_schema_field	Visible Foreground Color Style	FilterCriteria.visibleForegroundColorStyle (object)	The foreground color to filter by; only cells with this foreground color are shown. This field is mutually exclusive with visible_background_color, and must be set to an RGB-type color. If visible_foreground_color is also set, this field takes precedence.
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.filterSpecs.filterCriteria.visibleForegroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.filterSpecs.filterCriteria.condition	api_schema_field	Condition	FilterCriteria.condition (object)	A condition that must be `true` for values to be shown. (This does not override hidden_values -- if a value is listed there, it will still be hidden.)
ChartSpec.filterSpecs.filterCriteria.condition.type	api_schema_field	Type	BooleanCondition.type (string)	The type of condition.
ChartSpec.filterSpecs.filterCriteria.condition.values	api_schema_field	Values	BooleanCondition.values (array)	The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColorStyle	api_schema_field	Visible Background Color Style	FilterCriteria.visibleBackgroundColorStyle (object)	The background fill color to filter by; only cells with this fill color are shown. This field is mutually exclusive with visible_foreground_color, and must be set to an RGB-type color. If visible_background_color is also set, this field takes precedence.
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.filterSpecs.filterCriteria.visibleBackgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.filterSpecs.columnIndex	api_schema_field	Column Index	FilterSpec.columnIndex (integer)	The zero-based column index.
ChartSpec.bubbleChart	api_schema_field	Bubble Chart	ChartSpec.bubbleChart (object)	A bubble chart specification.
ChartSpec.bubbleChart.bubbleTextStyle	api_schema_field	Bubble Text Style	BubbleChartSpec.bubbleTextStyle (object)	The format of the text inside the bubbles. Strikethrough, underline, and link are not supported.
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.bubbleChart.bubbleTextStyle.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleTextStyle.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.bubbleChart.bubbleTextStyle.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
ChartSpec.bubbleChart.bubbleTextStyle.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.bubbleChart.bubbleTextStyle.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.bubbleChart.bubbleTextStyle.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.bubbleChart.bubbleTextStyle.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.bubbleChart.bubbleTextStyle.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.bubbleChart.bubbleTextStyle.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.bubbleChart.bubbleMaxRadiusSize	api_schema_field	Bubble Max Radius Size	BubbleChartSpec.bubbleMaxRadiusSize (integer)	The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.
ChartSpec.bubbleChart.bubbleBorderColor	api_schema_field	Bubble Border Color	BubbleChartSpec.bubbleBorderColor (object)	The bubble border color. Deprecated: Use bubble_border_color_style.
ChartSpec.bubbleChart.bubbleBorderColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleBorderColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleBorderColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.bubbleChart.bubbleBorderColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleSizes	api_schema_field	Bubble Sizes	BubbleChartSpec.bubbleSizes (object)	The data containing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional.
ChartSpec.bubbleChart.bubbleSizes.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.bubbleChart.bubbleSizes.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.bubbleChart.bubbleSizes.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.bubbleSizes.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.bubbleChart.bubbleSizes.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.bubbleChart.bubbleSizes.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.bubbleSizes.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.bubbleChart.bubbleSizes.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.bubbleChart.groupIds	api_schema_field	Group Ids	BubbleChartSpec.groupIds (object)	The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional.
ChartSpec.bubbleChart.groupIds.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.bubbleChart.groupIds.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.bubbleChart.groupIds.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.groupIds.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.bubbleChart.groupIds.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.bubbleChart.groupIds.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.groupIds.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.bubbleChart.groupIds.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.bubbleChart.bubbleLabels	api_schema_field	Bubble Labels	BubbleChartSpec.bubbleLabels (object)	The data containing the bubble labels. These do not need to be unique.
ChartSpec.bubbleChart.bubbleLabels.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.bubbleChart.bubbleLabels.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.bubbleChart.bubbleLabels.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.bubbleLabels.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.bubbleChart.bubbleLabels.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.bubbleChart.bubbleLabels.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.bubbleLabels.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.bubbleChart.bubbleLabels.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.bubbleChart.bubbleMinRadiusSize	api_schema_field	Bubble Min Radius Size	BubbleChartSpec.bubbleMinRadiusSize (integer)	The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.
ChartSpec.bubbleChart.series	api_schema_field	Series	BubbleChartSpec.series (object)	The data containing the bubble y-values. These values locate the bubbles in the chart vertically.
ChartSpec.bubbleChart.series.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.bubbleChart.series.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.bubbleChart.series.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.series.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.bubbleChart.series.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.bubbleChart.series.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.series.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.bubbleChart.series.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.bubbleChart.bubbleOpacity	api_schema_field	Bubble Opacity	BubbleChartSpec.bubbleOpacity (number)	The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
ChartSpec.bubbleChart.bubbleBorderColorStyle	api_schema_field	Bubble Border Color Style	BubbleChartSpec.bubbleBorderColorStyle (object)	The bubble border color. If bubble_border_color is also set, this field takes precedence.
ChartSpec.bubbleChart.bubbleBorderColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.bubbleChart.bubbleBorderColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleBorderColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleBorderColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.bubbleChart.bubbleBorderColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.bubbleChart.bubbleBorderColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.bubbleChart.legendPosition	api_schema_field	Legend Position	BubbleChartSpec.legendPosition (string)	Where the legend of the chart should be drawn.
ChartSpec.bubbleChart.domain	api_schema_field	Domain	BubbleChartSpec.domain (object)	The data containing the bubble x-values. These values locate the bubbles in the chart horizontally.
ChartSpec.bubbleChart.domain.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.bubbleChart.domain.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.bubbleChart.domain.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.domain.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.bubbleChart.domain.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.bubbleChart.domain.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.bubbleChart.domain.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.bubbleChart.domain.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.histogramChart	api_schema_field	Histogram Chart	ChartSpec.histogramChart (object)	A histogram chart specification.
ChartSpec.histogramChart.legendPosition	api_schema_field	Legend Position	HistogramChartSpec.legendPosition (string)	The position of the chart legend.
ChartSpec.histogramChart.bucketSize	api_schema_field	Bucket Size	HistogramChartSpec.bucketSize (number)	By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.
ChartSpec.histogramChart.showItemDividers	api_schema_field	Show Item Dividers	HistogramChartSpec.showItemDividers (boolean)	Whether horizontal divider lines should be displayed between items in each column.
ChartSpec.histogramChart.outlierPercentile	api_schema_field	Outlier Percentile	HistogramChartSpec.outlierPercentile (number)	The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still in…
ChartSpec.histogramChart.series	api_schema_field	Series	HistogramChartSpec.series (array)	The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.
ChartSpec.histogramChart.series.barColor	api_schema_field	Bar Color	HistogramSeries.barColor (object)	The color of the column representing this series in each bucket. This field is optional. Deprecated: Use bar_color_style.
ChartSpec.histogramChart.series.barColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.histogramChart.series.barColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.histogramChart.series.barColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.histogramChart.series.barColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.histogramChart.series.data	api_schema_field	Data	HistogramSeries.data (object)	The data for this histogram series.
ChartSpec.histogramChart.series.data.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.histogramChart.series.data.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.histogramChart.series.data.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.histogramChart.series.data.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.histogramChart.series.barColorStyle	api_schema_field	Bar Color Style	HistogramSeries.barColorStyle (object)	The color of the column representing this series in each bucket. This field is optional. If bar_color is also set, this field takes precedence.
ChartSpec.histogramChart.series.barColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.histogramChart.series.barColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.scorecardChart	api_schema_field	Scorecard Chart	ChartSpec.scorecardChart (object)	A scorecard chart specification.
ChartSpec.scorecardChart.keyValueData	api_schema_field	Key Value Data	ScorecardChartSpec.keyValueData (object)	The data for scorecard key value.
ChartSpec.scorecardChart.keyValueData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.scorecardChart.keyValueData.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.scorecardChart.keyValueData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.scorecardChart.keyValueData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.scorecardChart.keyValueData.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.scorecardChart.keyValueData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.scorecardChart.keyValueData.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.scorecardChart.keyValueData.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.scorecardChart.baselineValueData	api_schema_field	Baseline Value Data	ScorecardChartSpec.baselineValueData (object)	The data for scorecard baseline value. This field is optional.
ChartSpec.scorecardChart.baselineValueData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.scorecardChart.baselineValueData.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.scorecardChart.baselineValueData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.scorecardChart.baselineValueData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.scorecardChart.baselineValueData.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.scorecardChart.baselineValueData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.scorecardChart.baselineValueData.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.scorecardChart.baselineValueData.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.scorecardChart.baselineValueFormat	api_schema_field	Baseline Value Format	ScorecardChartSpec.baselineValueFormat (object)	Formatting options for baseline value. This field is needed only if baseline_value_data is specified.
ChartSpec.scorecardChart.baselineValueFormat.textFormat	api_schema_field	Text Format	BaselineValueFormat.textFormat (object)	Text formatting options for baseline value. The link field is not supported.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.scorecardChart.baselineValueFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.scorecardChart.baselineValueFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.scorecardChart.baselineValueFormat.positiveColor	api_schema_field	Positive Color	BaselineValueFormat.positiveColor (object)	Color to be used, in case baseline value represents a positive change for key value. This field is optional. Deprecated: Use positive_color_style.
ChartSpec.scorecardChart.baselineValueFormat.positiveColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.positiveColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.positiveColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.scorecardChart.baselineValueFormat.positiveColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.position	api_schema_field	Position	BaselineValueFormat.position (object)	Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.
ChartSpec.scorecardChart.baselineValueFormat.position.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
ChartSpec.scorecardChart.baselineValueFormat.negativeColor	api_schema_field	Negative Color	BaselineValueFormat.negativeColor (object)	Color to be used, in case baseline value represents a negative change for key value. This field is optional. Deprecated: Use negative_color_style.
ChartSpec.scorecardChart.baselineValueFormat.negativeColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.negativeColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.negativeColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.scorecardChart.baselineValueFormat.negativeColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.scorecardChart.baselineValueFormat.comparisonType	api_schema_field	Comparison Type	BaselineValueFormat.comparisonType (string)	The comparison type of key value with baseline value.
ChartSpec.scorecardChart.baselineValueFormat.positiveColorStyle	api_schema_field	Positive Color Style	BaselineValueFormat.positiveColorStyle (object)	Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positive_color is also set, this field takes precedence.
ChartSpec.scorecardChart.baselineValueFormat.positiveColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.scorecardChart.baselineValueFormat.positiveColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.scorecardChart.baselineValueFormat.description	api_schema_field	Description	BaselineValueFormat.description (string)	Description which is appended after the baseline value. This field is optional.
ChartSpec.scorecardChart.baselineValueFormat.negativeColorStyle	api_schema_field	Negative Color Style	BaselineValueFormat.negativeColorStyle (object)	Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negative_color is also set, this field takes precedence.
ChartSpec.scorecardChart.baselineValueFormat.negativeColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.scorecardChart.baselineValueFormat.negativeColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.scorecardChart.scaleFactor	api_schema_field	Scale Factor	ScorecardChartSpec.scaleFactor (number)	Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.
ChartSpec.scorecardChart.aggregateType	api_schema_field	Aggregate Type	ScorecardChartSpec.aggregateType (string)	The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optio…
ChartSpec.scorecardChart.numberFormatSource	api_schema_field	Number Format Source	ScorecardChartSpec.numberFormatSource (string)	The number format source used in the scorecard chart. This field is optional.
ChartSpec.scorecardChart.customFormatOptions	api_schema_field	Custom Format Options	ScorecardChartSpec.customFormatOptions (object)	Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional.
ChartSpec.scorecardChart.customFormatOptions.suffix	api_schema_field	Suffix	ChartCustomNumberFormatOptions.suffix (string)	Custom suffix to be appended to the chart attribute. This field is optional.
ChartSpec.scorecardChart.customFormatOptions.prefix	api_schema_field	Prefix	ChartCustomNumberFormatOptions.prefix (string)	Custom prefix to be prepended to the chart attribute. This field is optional.
ChartSpec.scorecardChart.keyValueFormat	api_schema_field	Key Value Format	ScorecardChartSpec.keyValueFormat (object)	Formatting options for key value.
ChartSpec.scorecardChart.keyValueFormat.textFormat	api_schema_field	Text Format	KeyValueFormat.textFormat (object)	Text formatting options for key value. The link field is not supported.
ChartSpec.scorecardChart.keyValueFormat.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.scorecardChart.keyValueFormat.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.scorecardChart.keyValueFormat.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.scorecardChart.keyValueFormat.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.scorecardChart.keyValueFormat.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.scorecardChart.keyValueFormat.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.scorecardChart.keyValueFormat.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.scorecardChart.keyValueFormat.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.scorecardChart.keyValueFormat.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.scorecardChart.keyValueFormat.position	api_schema_field	Position	KeyValueFormat.position (object)	Specifies the horizontal text positioning of key value. This field is optional. If not specified, default positioning is used.
ChartSpec.scorecardChart.keyValueFormat.position.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
ChartSpec.waterfallChart	api_schema_field	Waterfall Chart	ChartSpec.waterfallChart (object)	A waterfall chart specification.
ChartSpec.waterfallChart.domain	api_schema_field	Domain	WaterfallChartSpec.domain (object)	The domain data (horizontal axis) for the waterfall chart.
ChartSpec.waterfallChart.domain.data	api_schema_field	Data	WaterfallChartDomain.data (object)	The data of the WaterfallChartDomain.
ChartSpec.waterfallChart.domain.data.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.waterfallChart.domain.data.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.domain.data.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.waterfallChart.domain.data.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.domain.reversed	api_schema_field	Reversed	WaterfallChartDomain.reversed (boolean)	True to reverse the order of the domain values (horizontal axis).
ChartSpec.waterfallChart.totalDataLabel	api_schema_field	Total Data Label	WaterfallChartSpec.totalDataLabel (object)	Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label.
ChartSpec.waterfallChart.totalDataLabel.placement	api_schema_field	Placement	DataLabel.placement (string)	The placement of the data label relative to the labeled data.
ChartSpec.waterfallChart.totalDataLabel.textFormat	api_schema_field	Text Format	DataLabel.textFormat (object)	The text format used for the data label. The link field is not supported.
ChartSpec.waterfallChart.totalDataLabel.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.waterfallChart.totalDataLabel.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.waterfallChart.totalDataLabel.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.waterfallChart.totalDataLabel.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.waterfallChart.totalDataLabel.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.waterfallChart.totalDataLabel.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.waterfallChart.totalDataLabel.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.waterfallChart.totalDataLabel.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.waterfallChart.totalDataLabel.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.waterfallChart.totalDataLabel.customLabelData	api_schema_field	Custom Label Data	DataLabel.customLabelData (object)	Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from…
ChartSpec.waterfallChart.totalDataLabel.customLabelData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.waterfallChart.totalDataLabel.customLabelData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.totalDataLabel.customLabelData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.waterfallChart.totalDataLabel.customLabelData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.totalDataLabel.type	api_schema_field	Type	DataLabel.type (string)	The type of the data label.
ChartSpec.waterfallChart.stackedType	api_schema_field	Stacked Type	WaterfallChartSpec.stackedType (string)	The stacked type.
ChartSpec.waterfallChart.firstValueIsTotal	api_schema_field	First Value Is Total	WaterfallChartSpec.firstValueIsTotal (boolean)	True to interpret the first value as a total.
ChartSpec.waterfallChart.hideConnectorLines	api_schema_field	Hide Connector Lines	WaterfallChartSpec.hideConnectorLines (boolean)	True to hide connector lines between columns.
ChartSpec.waterfallChart.series	api_schema_field	Series	WaterfallChartSpec.series (array)	The data this waterfall chart is visualizing.
ChartSpec.waterfallChart.series.positiveColumnsStyle	api_schema_field	Positive Columns Style	WaterfallChartSeries.positiveColumnsStyle (object)	Styles for all columns in this series with positive values.
ChartSpec.waterfallChart.series.positiveColumnsStyle.label	api_schema_field	Label	WaterfallChartColumnStyle.label (string)	The label of the column's legend.
ChartSpec.waterfallChart.series.positiveColumnsStyle.color	api_schema_field	Color	WaterfallChartColumnStyle.color (object)	The color of the column. Deprecated: Use color_style.
ChartSpec.waterfallChart.series.positiveColumnsStyle.colorStyle	api_schema_field	Color Style	WaterfallChartColumnStyle.colorStyle (object)	The color of the column. If color is also set, this field takes precedence.
ChartSpec.waterfallChart.series.subtotalColumnsStyle	api_schema_field	Subtotal Columns Style	WaterfallChartSeries.subtotalColumnsStyle (object)	Styles for all subtotal columns in this series.
ChartSpec.waterfallChart.series.subtotalColumnsStyle.label	api_schema_field	Label	WaterfallChartColumnStyle.label (string)	The label of the column's legend.
ChartSpec.waterfallChart.series.subtotalColumnsStyle.color	api_schema_field	Color	WaterfallChartColumnStyle.color (object)	The color of the column. Deprecated: Use color_style.
ChartSpec.waterfallChart.series.subtotalColumnsStyle.colorStyle	api_schema_field	Color Style	WaterfallChartColumnStyle.colorStyle (object)	The color of the column. If color is also set, this field takes precedence.
ChartSpec.waterfallChart.series.hideTrailingSubtotal	api_schema_field	Hide Trailing Subtotal	WaterfallChartSeries.hideTrailingSubtotal (boolean)	True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.
ChartSpec.waterfallChart.series.negativeColumnsStyle	api_schema_field	Negative Columns Style	WaterfallChartSeries.negativeColumnsStyle (object)	Styles for all columns in this series with negative values.
ChartSpec.waterfallChart.series.negativeColumnsStyle.label	api_schema_field	Label	WaterfallChartColumnStyle.label (string)	The label of the column's legend.
ChartSpec.waterfallChart.series.negativeColumnsStyle.color	api_schema_field	Color	WaterfallChartColumnStyle.color (object)	The color of the column. Deprecated: Use color_style.
ChartSpec.waterfallChart.series.negativeColumnsStyle.colorStyle	api_schema_field	Color Style	WaterfallChartColumnStyle.colorStyle (object)	The color of the column. If color is also set, this field takes precedence.
ChartSpec.waterfallChart.series.customSubtotals	api_schema_field	Custom Subtotals	WaterfallChartSeries.customSubtotals (array)	Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.
ChartSpec.waterfallChart.series.customSubtotals.dataIsSubtotal	api_schema_field	Data Is Subtotal	WaterfallChartCustomSubtotal.dataIsSubtotal (boolean)	True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point.
ChartSpec.waterfallChart.series.customSubtotals.subtotalIndex	api_schema_field	Subtotal Index	WaterfallChartCustomSubtotal.subtotalIndex (integer)	The zero-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices,…
ChartSpec.waterfallChart.series.customSubtotals.label	api_schema_field	Label	WaterfallChartCustomSubtotal.label (string)	A label for the subtotal column.
ChartSpec.waterfallChart.series.data	api_schema_field	Data	WaterfallChartSeries.data (object)	The data being visualized in this series.
ChartSpec.waterfallChart.series.data.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.waterfallChart.series.data.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.series.data.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.waterfallChart.series.data.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.waterfallChart.series.dataLabel	api_schema_field	Data Label	WaterfallChartSeries.dataLabel (object)	Information about the data labels for this series.
ChartSpec.waterfallChart.series.dataLabel.placement	api_schema_field	Placement	DataLabel.placement (string)	The placement of the data label relative to the labeled data.
ChartSpec.waterfallChart.series.dataLabel.textFormat	api_schema_field	Text Format	DataLabel.textFormat (object)	The text format used for the data label. The link field is not supported.
ChartSpec.waterfallChart.series.dataLabel.customLabelData	api_schema_field	Custom Label Data	DataLabel.customLabelData (object)	Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from…
ChartSpec.waterfallChart.series.dataLabel.type	api_schema_field	Type	DataLabel.type (string)	The type of the data label.
ChartSpec.waterfallChart.connectorLineStyle	api_schema_field	Connector Line Style	WaterfallChartSpec.connectorLineStyle (object)	The line style for the connector lines.
ChartSpec.waterfallChart.connectorLineStyle.width	api_schema_field	Width	LineStyle.width (integer)	The thickness of the line, in px.
ChartSpec.waterfallChart.connectorLineStyle.type	api_schema_field	Type	LineStyle.type (string)	The dash type of the line.
ChartSpec.candlestickChart	api_schema_field	Candlestick Chart	ChartSpec.candlestickChart (object)	A candlestick chart specification.
ChartSpec.candlestickChart.domain	api_schema_field	Domain	CandlestickChartSpec.domain (object)	The domain data (horizontal axis) for the candlestick chart. String data will be treated as discrete labels, other data will be treated as continuous values.
ChartSpec.candlestickChart.domain.data	api_schema_field	Data	CandlestickDomain.data (object)	The data of the CandlestickDomain.
ChartSpec.candlestickChart.domain.data.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.candlestickChart.domain.data.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.candlestickChart.domain.data.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.candlestickChart.domain.data.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.candlestickChart.domain.reversed	api_schema_field	Reversed	CandlestickDomain.reversed (boolean)	True to reverse the order of the domain values (horizontal axis).
ChartSpec.candlestickChart.data	api_schema_field	Data	CandlestickChartSpec.data (array)	The Candlestick chart data. Only one CandlestickData is supported.
ChartSpec.candlestickChart.data.lowSeries	api_schema_field	Low Series	CandlestickData.lowSeries (object)	The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of the candle's center line.
ChartSpec.candlestickChart.data.lowSeries.data	api_schema_field	Data	CandlestickSeries.data (object)	The data of the CandlestickSeries.
ChartSpec.candlestickChart.data.closeSeries	api_schema_field	Close Series	CandlestickData.closeSeries (object)	The range data (vertical axis) for the close/final value for each candle. This is the top of the candle body. If greater than the open value the candle will be filled. Otherwise the candle will be hollow.
ChartSpec.candlestickChart.data.closeSeries.data	api_schema_field	Data	CandlestickSeries.data (object)	The data of the CandlestickSeries.
ChartSpec.candlestickChart.data.openSeries	api_schema_field	Open Series	CandlestickData.openSeries (object)	The range data (vertical axis) for the open/initial value for each candle. This is the bottom of the candle body. If less than the close value the candle will be filled. Otherwise the candle will be hollow.
ChartSpec.candlestickChart.data.openSeries.data	api_schema_field	Data	CandlestickSeries.data (object)	The data of the CandlestickSeries.
ChartSpec.candlestickChart.data.highSeries	api_schema_field	High Series	CandlestickData.highSeries (object)	The range data (vertical axis) for the high/maximum value for each candle. This is the top of the candle's center line.
ChartSpec.candlestickChart.data.highSeries.data	api_schema_field	Data	CandlestickSeries.data (object)	The data of the CandlestickSeries.
ChartSpec.altText	api_schema_field	Alt Text	ChartSpec.altText (string)	The alternative text that describes the chart. This is often used for accessibility.
ChartSpec.basicChart	api_schema_field	Basic Chart	ChartSpec.basicChart (object)	A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
ChartSpec.basicChart.chartType	api_schema_field	Chart Type	BasicChartSpec.chartType (string)	The type of the chart.
ChartSpec.basicChart.legendPosition	api_schema_field	Legend Position	BasicChartSpec.legendPosition (string)	The position of the chart legend.
ChartSpec.basicChart.axis	api_schema_field	Axis	BasicChartSpec.axis (array)	The axis on the chart.
ChartSpec.basicChart.axis.position	api_schema_field	Position	BasicChartAxis.position (string)	The position of this axis.
ChartSpec.basicChart.axis.title	api_schema_field	Title	BasicChartAxis.title (string)	The title of this axis. If set, this overrides any title inferred from headers of the data.
ChartSpec.basicChart.axis.viewWindowOptions	api_schema_field	View Window Options	BasicChartAxis.viewWindowOptions (object)	The view window options for this axis.
ChartSpec.basicChart.axis.viewWindowOptions.viewWindowMode	api_schema_field	View Window Mode	ChartAxisViewWindowOptions.viewWindowMode (string)	The view window's mode.
ChartSpec.basicChart.axis.viewWindowOptions.viewWindowMax	api_schema_field	View Window Max	ChartAxisViewWindowOptions.viewWindowMax (number)	The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.
ChartSpec.basicChart.axis.viewWindowOptions.viewWindowMin	api_schema_field	View Window Min	ChartAxisViewWindowOptions.viewWindowMin (number)	The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.
ChartSpec.basicChart.axis.format	api_schema_field	Format	BasicChartAxis.format (object)	The format of the title. Only valid if the axis is not associated with the domain. The link field is not supported.
ChartSpec.basicChart.axis.format.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.basicChart.axis.format.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.basicChart.axis.format.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.basicChart.axis.format.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.basicChart.axis.format.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.basicChart.axis.format.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.basicChart.axis.format.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.basicChart.axis.format.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.basicChart.axis.format.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.basicChart.axis.titleTextPosition	api_schema_field	Title Text Position	BasicChartAxis.titleTextPosition (object)	The axis title text position.
ChartSpec.basicChart.axis.titleTextPosition.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
ChartSpec.basicChart.threeDimensional	api_schema_field	Three Dimensional	BasicChartSpec.threeDimensional (boolean)	True to make the chart 3D. Applies to Bar and Column charts.
ChartSpec.basicChart.series	api_schema_field	Series	BasicChartSpec.series (array)	The data this chart is visualizing.
ChartSpec.basicChart.series.series	api_schema_field	Series	BasicChartSeries.series (object)	The data being visualized in this chart series.
ChartSpec.basicChart.series.series.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.basicChart.series.series.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.series.series.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.basicChart.series.series.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.series.styleOverrides	api_schema_field	Style Overrides	BasicChartSeries.styleOverrides (array)	Style override settings for series data points.
ChartSpec.basicChart.series.styleOverrides.pointStyle	api_schema_field	Point Style	BasicSeriesDataPointStyleOverride.pointStyle (object)	Point style of the series data point. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, the series default is used.
ChartSpec.basicChart.series.styleOverrides.index	api_schema_field	Index	BasicSeriesDataPointStyleOverride.index (integer)	The zero-based index of the series data point.
ChartSpec.basicChart.series.styleOverrides.color	api_schema_field	Color	BasicSeriesDataPointStyleOverride.color (object)	Color of the series data point. If empty, the series default is used. Deprecated: Use color_style.
ChartSpec.basicChart.series.styleOverrides.colorStyle	api_schema_field	Color Style	BasicSeriesDataPointStyleOverride.colorStyle (object)	Color of the series data point. If empty, the series default is used. If color is also set, this field takes precedence.
ChartSpec.basicChart.series.pointStyle	api_schema_field	Point Style	BasicChartSeries.pointStyle (object)	The style for points associated with this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, a default point style is used.
ChartSpec.basicChart.series.pointStyle.shape	api_schema_field	Shape	PointStyle.shape (string)	The point shape. If empty or unspecified, a default shape is used.
ChartSpec.basicChart.series.pointStyle.size	api_schema_field	Size	PointStyle.size (number)	The point size. If empty, a default size is used.
ChartSpec.basicChart.series.color	api_schema_field	Color	BasicChartSeries.color (object)	The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style.
ChartSpec.basicChart.series.color.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.basicChart.series.color.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.basicChart.series.color.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.basicChart.series.color.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.basicChart.series.dataLabel	api_schema_field	Data Label	BasicChartSeries.dataLabel (object)	Information about the data labels for this series.
ChartSpec.basicChart.series.dataLabel.placement	api_schema_field	Placement	DataLabel.placement (string)	The placement of the data label relative to the labeled data.
ChartSpec.basicChart.series.dataLabel.textFormat	api_schema_field	Text Format	DataLabel.textFormat (object)	The text format used for the data label. The link field is not supported.
ChartSpec.basicChart.series.dataLabel.customLabelData	api_schema_field	Custom Label Data	DataLabel.customLabelData (object)	Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from…
ChartSpec.basicChart.series.dataLabel.type	api_schema_field	Type	DataLabel.type (string)	The type of the data label.
ChartSpec.basicChart.series.colorStyle	api_schema_field	Color Style	BasicChartSeries.colorStyle (object)	The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence.
ChartSpec.basicChart.series.colorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.basicChart.series.colorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.basicChart.series.targetAxis	api_schema_field	Target Axis	BasicChartSeries.targetAxis (string)	The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than t…
ChartSpec.basicChart.series.type	api_schema_field	Type	BasicChartSeries.type (string)	The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.
ChartSpec.basicChart.series.lineStyle	api_schema_field	Line Style	BasicChartSeries.lineStyle (object)	The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE.
ChartSpec.basicChart.series.lineStyle.width	api_schema_field	Width	LineStyle.width (integer)	The thickness of the line, in px.
ChartSpec.basicChart.series.lineStyle.type	api_schema_field	Type	LineStyle.type (string)	The dash type of the line.
ChartSpec.basicChart.stackedType	api_schema_field	Stacked Type	BasicChartSpec.stackedType (string)	The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.
ChartSpec.basicChart.headerCount	api_schema_field	Header Count	BasicChartSpec.headerCount (integer)	The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)
ChartSpec.basicChart.lineSmoothing	api_schema_field	Line Smoothing	BasicChartSpec.lineSmoothing (boolean)	Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.
ChartSpec.basicChart.totalDataLabel	api_schema_field	Total Data Label	BasicChartSpec.totalDataLabel (object)	Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and…
ChartSpec.basicChart.totalDataLabel.placement	api_schema_field	Placement	DataLabel.placement (string)	The placement of the data label relative to the labeled data.
ChartSpec.basicChart.totalDataLabel.textFormat	api_schema_field	Text Format	DataLabel.textFormat (object)	The text format used for the data label. The link field is not supported.
ChartSpec.basicChart.totalDataLabel.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.basicChart.totalDataLabel.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.basicChart.totalDataLabel.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.basicChart.totalDataLabel.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.basicChart.totalDataLabel.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.basicChart.totalDataLabel.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.basicChart.totalDataLabel.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.basicChart.totalDataLabel.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.basicChart.totalDataLabel.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.basicChart.totalDataLabel.customLabelData	api_schema_field	Custom Label Data	DataLabel.customLabelData (object)	Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from…
ChartSpec.basicChart.totalDataLabel.customLabelData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.basicChart.totalDataLabel.customLabelData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.totalDataLabel.customLabelData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.basicChart.totalDataLabel.customLabelData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.totalDataLabel.type	api_schema_field	Type	DataLabel.type (string)	The type of the data label.
ChartSpec.basicChart.interpolateNulls	api_schema_field	Interpolate Nulls	BasicChartSpec.interpolateNulls (boolean)	If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.
ChartSpec.basicChart.domains	api_schema_field	Domains	BasicChartSpec.domains (array)	The domain of data this is charting. Only a single domain is supported.
ChartSpec.basicChart.domains.domain	api_schema_field	Domain	BasicChartDomain.domain (object)	The data of the domain. For example, if charting stock prices over time, this is the data representing the dates.
ChartSpec.basicChart.domains.domain.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.basicChart.domains.domain.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.domains.domain.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.basicChart.domains.domain.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.basicChart.domains.reversed	api_schema_field	Reversed	BasicChartDomain.reversed (boolean)	True to reverse the order of the domain values (horizontal axis).
ChartSpec.basicChart.compareMode	api_schema_field	Compare Mode	BasicChartSpec.compareMode (string)	The behavior of tooltips and data highlighting when hovering on data and chart area.
ChartSpec.subtitle	api_schema_field	Subtitle	ChartSpec.subtitle (string)	The subtitle of the chart.
ChartSpec.subtitleTextPosition	api_schema_field	Subtitle Text Position	ChartSpec.subtitleTextPosition (object)	The subtitle text position. This field is optional.
ChartSpec.subtitleTextPosition.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.
ChartSpec.backgroundColor	api_schema_field	Background Color	ChartSpec.backgroundColor (object)	The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
ChartSpec.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.pieChart	api_schema_field	Pie Chart	ChartSpec.pieChart (object)	A pie chart specification.
ChartSpec.pieChart.series	api_schema_field	Series	PieChartSpec.series (object)	The data that covers the one and only series of the pie chart.
ChartSpec.pieChart.series.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.pieChart.series.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.pieChart.series.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.pieChart.series.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.pieChart.series.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.pieChart.series.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.pieChart.series.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.pieChart.series.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.pieChart.domain	api_schema_field	Domain	PieChartSpec.domain (object)	The data that covers the domain of the pie chart.
ChartSpec.pieChart.domain.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.pieChart.domain.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.pieChart.domain.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.pieChart.domain.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.pieChart.domain.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.pieChart.domain.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.pieChart.domain.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.pieChart.domain.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.pieChart.threeDimensional	api_schema_field	Three Dimensional	PieChartSpec.threeDimensional (boolean)	True if the pie is three dimensional.
ChartSpec.pieChart.pieHole	api_schema_field	Pie Hole	PieChartSpec.pieHole (number)	The size of the hole in the pie chart.
ChartSpec.pieChart.legendPosition	api_schema_field	Legend Position	PieChartSpec.legendPosition (string)	Where the legend of the pie chart should be drawn.
ChartSpec.treemapChart	api_schema_field	Treemap Chart	ChartSpec.treemapChart (object)	A treemap chart specification.
ChartSpec.treemapChart.headerColorStyle	api_schema_field	Header Color Style	TreemapChartSpec.headerColorStyle (object)	The background color for header cells. If header_color is also set, this field takes precedence.
ChartSpec.treemapChart.headerColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.headerColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.headerColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.headerColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.headerColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.headerColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.textFormat	api_schema_field	Text Format	TreemapChartSpec.textFormat (object)	The text format for all labels on the chart. The link field is not supported.
ChartSpec.treemapChart.textFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.treemapChart.textFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.textFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.textFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.treemapChart.textFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.textFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.textFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.textFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.textFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.treemapChart.textFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
ChartSpec.treemapChart.textFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.treemapChart.textFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.treemapChart.textFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.treemapChart.textFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.treemapChart.textFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.treemapChart.textFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.treemapChart.parentLabels	api_schema_field	Parent Labels	TreemapChartSpec.parentLabels (object)	The data the contains the treemap cells' parent labels.
ChartSpec.treemapChart.parentLabels.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.treemapChart.parentLabels.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.treemapChart.parentLabels.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.parentLabels.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.treemapChart.parentLabels.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.treemapChart.parentLabels.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.parentLabels.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.treemapChart.parentLabels.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.treemapChart.levels	api_schema_field	Levels	TreemapChartSpec.levels (integer)	The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.
ChartSpec.treemapChart.hideTooltips	api_schema_field	Hide Tooltips	TreemapChartSpec.hideTooltips (boolean)	True to hide tooltips.
ChartSpec.treemapChart.sizeData	api_schema_field	Size Data	TreemapChartSpec.sizeData (object)	The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background…
ChartSpec.treemapChart.sizeData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.treemapChart.sizeData.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.treemapChart.sizeData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.sizeData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.treemapChart.sizeData.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.treemapChart.sizeData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.sizeData.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.treemapChart.sizeData.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.treemapChart.headerColor	api_schema_field	Header Color	TreemapChartSpec.headerColor (object)	The background color for header cells. Deprecated: Use header_color_style.
ChartSpec.treemapChart.headerColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.headerColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.headerColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.headerColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.labels	api_schema_field	Labels	TreemapChartSpec.labels (object)	The data that contains the treemap cell labels.
ChartSpec.treemapChart.labels.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.treemapChart.labels.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.treemapChart.labels.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.labels.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.treemapChart.labels.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.treemapChart.labels.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.labels.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.treemapChart.labels.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.treemapChart.colorData	api_schema_field	Color Data	TreemapChartSpec.colorData (object)	The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in…
ChartSpec.treemapChart.colorData.columnReference	api_schema_field	Column Reference	ChartData.columnReference (object)	The reference to the data source column that the data reads from.
ChartSpec.treemapChart.colorData.columnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.treemapChart.colorData.aggregateType	api_schema_field	Aggregate Type	ChartData.aggregateType (string)	The aggregation type for the series of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.colorData.sourceRange	api_schema_field	Source Range	ChartData.sourceRange (object)	The source ranges of the data.
ChartSpec.treemapChart.colorData.sourceRange.sources	api_schema_field	Sources	ChartSourceRange.sources (array)	The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more…
ChartSpec.treemapChart.colorData.groupRule	api_schema_field	Group Rule	ChartData.groupRule (object)	The rule to group the data by if the ChartData backs the domain of a data source chart. Only supported for data source charts.
ChartSpec.treemapChart.colorData.groupRule.dateTimeRule	api_schema_field	Date Time Rule	ChartGroupRule.dateTimeRule (object)	A ChartDateTimeRule.
ChartSpec.treemapChart.colorData.groupRule.histogramRule	api_schema_field	Histogram Rule	ChartGroupRule.histogramRule (object)	A ChartHistogramRule
ChartSpec.treemapChart.minValue	api_schema_field	Min Value	TreemapChartSpec.minValue (number)	The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.
ChartSpec.treemapChart.maxValue	api_schema_field	Max Value	TreemapChartSpec.maxValue (number)	The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.
ChartSpec.treemapChart.hintedLevels	api_schema_field	Hinted Levels	TreemapChartSpec.hintedLevels (integer)	The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.
ChartSpec.treemapChart.colorScale	api_schema_field	Color Scale	TreemapChartSpec.colorScale (object)	The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value…
ChartSpec.treemapChart.colorScale.maxValueColorStyle	api_schema_field	Max Value Color Style	TreemapChartColorScale.maxValueColorStyle (object)	The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. If max_value_color is also set, this field takes precedence.
ChartSpec.treemapChart.colorScale.maxValueColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.colorScale.maxValueColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.colorScale.midValueColor	api_schema_field	Mid Value Color	TreemapChartColorScale.midValueColor (object)	The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. Deprecated: Use mid_value_color_style.
ChartSpec.treemapChart.colorScale.midValueColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.midValueColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.midValueColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.colorScale.midValueColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.midValueColorStyle	api_schema_field	Mid Value Color Style	TreemapChartColorScale.midValueColorStyle (object)	The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. If mid_value_color is also set, this field takes precedence.
ChartSpec.treemapChart.colorScale.midValueColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.colorScale.midValueColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.colorScale.minValueColor	api_schema_field	Min Value Color	TreemapChartColorScale.minValueColor (object)	The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. Deprecated: Use min_value_color_style.
ChartSpec.treemapChart.colorScale.minValueColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.minValueColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.minValueColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.colorScale.minValueColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.noDataColorStyle	api_schema_field	No Data Color Style	TreemapChartColorScale.noDataColorStyle (object)	The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. If no_data_color is also set, this field takes precedence.
ChartSpec.treemapChart.colorScale.noDataColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.colorScale.noDataColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.colorScale.maxValueColor	api_schema_field	Max Value Color	TreemapChartColorScale.maxValueColor (object)	The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. Deprecated: Use max_value_color_style.
ChartSpec.treemapChart.colorScale.maxValueColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.maxValueColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.maxValueColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.colorScale.maxValueColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.minValueColorStyle	api_schema_field	Min Value Color Style	TreemapChartColorScale.minValueColorStyle (object)	The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. If min_value_color is also set, this field takes precedence.
ChartSpec.treemapChart.colorScale.minValueColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.treemapChart.colorScale.minValueColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.treemapChart.colorScale.noDataColor	api_schema_field	No Data Color	TreemapChartColorScale.noDataColor (object)	The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. Deprecated: Use no_data_color_style.
ChartSpec.treemapChart.colorScale.noDataColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.noDataColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.treemapChart.colorScale.noDataColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.treemapChart.colorScale.noDataColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.fontName	schema_pii_or_identity_field	Font Name	ChartSpec.fontName (string)	The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
ChartSpec.subtitleTextFormat	api_schema_field	Subtitle Text Format	ChartSpec.subtitleTextFormat (object)	The subtitle text format. Strikethrough, underline, and link are not supported.
ChartSpec.subtitleTextFormat.foregroundColorStyle	api_schema_field	Foreground Color Style	TextFormat.foregroundColorStyle (object)	The foreground color of the text. If foreground_color is also set, this field takes precedence.
ChartSpec.subtitleTextFormat.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.subtitleTextFormat.foregroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.foregroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.foregroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.subtitleTextFormat.foregroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.subtitleTextFormat.foregroundColor	api_schema_field	Foreground Color	TextFormat.foregroundColor (object)	The foreground color of the text. Deprecated: Use foreground_color_style.
ChartSpec.subtitleTextFormat.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.subtitleTextFormat.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.subtitleTextFormat.link	api_schema_field	Link	TextFormat.link (object)	The link destination of the text, if any. Setting the link field in a TextFormatRun will clear the cell's existing links or a cell-level link set in the same request. When a link is set, the text foreground color will be set to the default link color and the…
ChartSpec.subtitleTextFormat.link.uri	api_schema_field	Uri	Link.uri (string)	The link identifier.
ChartSpec.subtitleTextFormat.italic	api_schema_field	Italic	TextFormat.italic (boolean)	True if the text is italicized.
ChartSpec.subtitleTextFormat.underline	api_schema_field	Underline	TextFormat.underline (boolean)	True if the text is underlined.
ChartSpec.subtitleTextFormat.fontSize	api_schema_field	Font Size	TextFormat.fontSize (integer)	The size of the font.
ChartSpec.subtitleTextFormat.fontFamily	api_schema_field	Font Family	TextFormat.fontFamily (string)	The font family.
ChartSpec.subtitleTextFormat.bold	api_schema_field	Bold	TextFormat.bold (boolean)	True if the text is bold.
ChartSpec.subtitleTextFormat.strikethrough	api_schema_field	Strikethrough	TextFormat.strikethrough (boolean)	True if the text has a strikethrough.
ChartSpec.sortSpecs	api_schema_field	Sort Specs	ChartSpec.sortSpecs (array)	The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
ChartSpec.sortSpecs.dataSourceColumnReference	api_schema_field	Data Source Column Reference	SortSpec.dataSourceColumnReference (object)	Reference to a data source column.
ChartSpec.sortSpecs.dataSourceColumnReference.name	schema_pii_or_identity_field	Name	DataSourceColumnReference.name (string)	The display name of the column. It should be unique within a data source.
ChartSpec.sortSpecs.sortOrder	api_schema_field	Sort Order	SortSpec.sortOrder (string)	The order data should be sorted.
ChartSpec.sortSpecs.backgroundColor	api_schema_field	Background Color	SortSpec.backgroundColor (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
ChartSpec.sortSpecs.backgroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.backgroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.backgroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.sortSpecs.backgroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.dimensionIndex	api_schema_field	Dimension Index	SortSpec.dimensionIndex (integer)	The dimension the sort should be applied to.
ChartSpec.sortSpecs.foregroundColorStyle	api_schema_field	Foreground Color Style	SortSpec.foregroundColorStyle (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
ChartSpec.sortSpecs.foregroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.sortSpecs.foregroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.foregroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.foregroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.sortSpecs.foregroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.foregroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.sortSpecs.backgroundColorStyle	api_schema_field	Background Color Style	SortSpec.backgroundColorStyle (object)	The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
ChartSpec.sortSpecs.backgroundColorStyle.rgbColor	api_schema_field	Rgb Color	ColorStyle.rgbColor (object)	RGB color. The [`alpha`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/other#color) object i…
ChartSpec.sortSpecs.backgroundColorStyle.rgbColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.backgroundColorStyle.rgbColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.backgroundColorStyle.rgbColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.sortSpecs.backgroundColorStyle.rgbColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.backgroundColorStyle.themeColor	api_schema_field	Theme Color	ColorStyle.themeColor (string)	Theme color.
ChartSpec.sortSpecs.foregroundColor	api_schema_field	Foreground Color	SortSpec.foregroundColor (object)	The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
ChartSpec.sortSpecs.foregroundColor.red	api_schema_field	Red	Color.red (number)	The amount of red in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.foregroundColor.green	api_schema_field	Green	Color.green (number)	The amount of green in the color as a value in the interval [0, 1].
ChartSpec.sortSpecs.foregroundColor.alpha	api_schema_field	Alpha	Color.alpha (number)	The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, w…
ChartSpec.sortSpecs.foregroundColor.blue	api_schema_field	Blue	Color.blue (number)	The amount of blue in the color as a value in the interval [0, 1].
ChartSpec.titleTextPosition	api_schema_field	Title Text Position	ChartSpec.titleTextPosition (object)	The title text position. This field is optional.
ChartSpec.titleTextPosition.horizontalAlignment	api_schema_field	Horizontal Alignment	TextPosition.horizontalAlignment (string)	Horizontal alignment setting for the piece of text.

Googleドキュメント

ドキュメント / Google Picker + OAuth

提供中

選択されたGoogleドキュメントの本文を読み取ります。

MCPツール

ツール	引数	戻り値	説明
list_documents	なし	document_id / title	接続済みドキュメントを一覧化する
read_document	document_id	text	ドキュメント本文を読み取る

フィールド

ID	型	表示名	媒体側API名	説明
Document.suggestionsViewMode	api_schema_field	Suggestions View Mode	Document.suggestionsViewMode (string)	Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.
Document.title	api_schema_field	Title	Document.title (string)	The title of the document.
Document.footnotes	api_schema_field	Footnotes	Document.footnotes (object)	Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or uns…
Document.inlineObjects	api_schema_field	Inline Objects	Document.inlineObjects (object)	Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false`…
Document.documentStyle	api_schema_field	Document Style	Document.documentStyle (object)	Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contain…
Document.documentStyle.marginFooter	api_schema_field	Margin Footer	DocumentStyle.marginFooter (object)	The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginFooter.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginFooter.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.useFirstPageHeaderFooter	api_schema_field	Use First Page Header Footer	DocumentStyle.useFirstPageHeaderFooter (boolean)	Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginHeader	api_schema_field	Margin Header	DocumentStyle.marginHeader (object)	The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginHeader.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginHeader.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.marginRight	api_schema_field	Margin Right	DocumentStyle.marginRight (object)	The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.flipPageOrientation	api_schema_field	Flip Page Orientation	DocumentStyle.flipPageOrientation (boolean)	Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.defaultFooterId	api_schema_field	Default Footer Id	DocumentStyle.defaultFooterId (string)	The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
Document.documentStyle.firstPageFooterId	api_schema_field	First Page Footer Id	DocumentStyle.firstPageFooterId (string)	The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If…
Document.documentStyle.background	api_schema_field	Background	DocumentStyle.background (object)	The background of the document. Documents cannot have a transparent background color.
Document.documentStyle.background.color	api_schema_field	Color	Background.color (object)	The background color.
Document.documentStyle.background.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Document.documentStyle.documentFormat	api_schema_field	Document Format	DocumentStyle.documentFormat (object)	Specifies document-level format settings, such as the document mode (pages vs pageless).
Document.documentStyle.documentFormat.documentMode	api_schema_field	Document Mode	DocumentFormat.documentMode (string)	Whether the document has pages or is pageless.
Document.documentStyle.marginTop	api_schema_field	Margin Top	DocumentStyle.marginTop (object)	The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.pageNumberStart	api_schema_field	Page Number Start	DocumentStyle.pageNumberStart (integer)	The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginBottom	api_schema_field	Margin Bottom	DocumentStyle.marginBottom (object)	The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.defaultHeaderId	api_schema_field	Default Header Id	DocumentStyle.defaultHeaderId (string)	The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
Document.documentStyle.useEvenPageHeaderFooter	api_schema_field	Use Even Page Header Footer	DocumentStyle.useEvenPageHeaderFooter (boolean)	Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.pageSize	api_schema_field	Page Size	DocumentStyle.pageSize (object)	The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.pageSize.height	api_schema_field	Height	Size.height (object)	The height of the object.
Document.documentStyle.pageSize.height.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.pageSize.height.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.pageSize.width	api_schema_field	Width	Size.width (object)	The width of the object.
Document.documentStyle.pageSize.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.pageSize.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.useCustomHeaderFooterMargins	api_schema_field	Use Custom Header Footer Margins	DocumentStyle.useCustomHeaderFooterMargins (boolean)	Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAG…
Document.documentStyle.evenPageFooterId	api_schema_field	Even Page Footer Id	DocumentStyle.evenPageFooterId (string)	The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this prop…
Document.documentStyle.marginLeft	api_schema_field	Margin Left	DocumentStyle.marginLeft (object)	The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
Document.documentStyle.marginLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Document.documentStyle.marginLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Document.documentStyle.firstPageHeaderId	api_schema_field	First Page Header Id	DocumentStyle.firstPageHeaderId (string)	The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If…
Document.documentStyle.evenPageHeaderId	api_schema_field	Even Page Header Id	DocumentStyle.evenPageHeaderId (string)	The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this prop…
Document.namedStyles	schema_pii_or_identity_field	Named Styles	Document.namedStyles (object)	Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field co…
Document.namedStyles.styles	schema_pii_or_identity_field	Styles	NamedStyles.styles (array)	The named styles. There's an entry for each of the possible named style types.
Document.namedStyles.styles.textStyle	schema_pii_or_identity_field	Text Style	NamedStyle.textStyle (object)	The text style of this named style.
Document.namedStyles.styles.textStyle.foregroundColor	schema_pii_or_identity_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Document.namedStyles.styles.textStyle.baselineOffset	schema_pii_or_identity_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Document.namedStyles.styles.textStyle.underline	schema_pii_or_identity_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Document.namedStyles.styles.textStyle.backgroundColor	schema_pii_or_identity_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Document.namedStyles.styles.textStyle.fontSize	schema_pii_or_identity_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Document.namedStyles.styles.textStyle.weightedFontFamily	schema_pii_or_identity_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Document.namedStyles.styles.textStyle.strikethrough	schema_pii_or_identity_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Document.namedStyles.styles.textStyle.link	schema_pii_or_identity_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Document.namedStyles.styles.textStyle.italic	schema_pii_or_identity_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Document.namedStyles.styles.textStyle.smallCaps	schema_pii_or_identity_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Document.namedStyles.styles.textStyle.bold	schema_pii_or_identity_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Document.namedStyles.styles.namedStyleType	schema_pii_or_identity_field	Named Style Type	NamedStyle.namedStyleType (string)	The type of this named style.
Document.namedStyles.styles.paragraphStyle	schema_pii_or_identity_field	Paragraph Style	NamedStyle.paragraphStyle (object)	The paragraph style of this named style.
Document.namedStyles.styles.paragraphStyle.borderTop	schema_pii_or_identity_field	Border Top	ParagraphStyle.borderTop (object)	The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph…
Document.namedStyles.styles.paragraphStyle.borderRight	schema_pii_or_identity_field	Border Right	ParagraphStyle.borderRight (object)	The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Document.namedStyles.styles.paragraphStyle.shading	schema_pii_or_identity_field	Shading	ParagraphStyle.shading (object)	The shading of the paragraph. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.headingId	schema_pii_or_identity_field	Heading Id	ParagraphStyle.headingId (string)	The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
Document.namedStyles.styles.paragraphStyle.indentFirstLine	schema_pii_or_identity_field	Indent First Line	ParagraphStyle.indentFirstLine (object)	The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.borderBetween	schema_pii_or_identity_field	Border Between	ParagraphStyle.borderBetween (object)	The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partial…
Document.namedStyles.styles.paragraphStyle.spaceAbove	schema_pii_or_identity_field	Space Above	ParagraphStyle.spaceAbove (object)	The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.indentStart	schema_pii_or_identity_field	Indent Start	ParagraphStyle.indentStart (object)	The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.tabStops	schema_pii_or_identity_field	Tab Stops	ParagraphStyle.tabStops (array)	A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
Document.namedStyles.styles.paragraphStyle.namedStyleType	schema_pii_or_identity_field	Named Style Type	ParagraphStyle.namedStyleType (string)	The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
Document.namedStyles.styles.paragraphStyle.alignment	schema_pii_or_identity_field	Alignment	ParagraphStyle.alignment (string)	The text alignment for this paragraph.
Document.namedStyles.styles.paragraphStyle.borderLeft	schema_pii_or_identity_field	Border Left	ParagraphStyle.borderLeft (object)	The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Document.namedStyles.styles.paragraphStyle.indentEnd	schema_pii_or_identity_field	Indent End	ParagraphStyle.indentEnd (object)	The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.pageBreakBefore	schema_pii_or_identity_field	Page Break Before	ParagraphStyle.pageBreakBefore (boolean)	Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can res…
Document.namedStyles.styles.paragraphStyle.borderBottom	schema_pii_or_identity_field	Border Bottom	ParagraphStyle.borderBottom (object)	The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a par…
Document.namedStyles.styles.paragraphStyle.direction	schema_pii_or_identity_field	Direction	ParagraphStyle.direction (string)	The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
Document.namedStyles.styles.paragraphStyle.keepWithNext	schema_pii_or_identity_field	Keep With Next	ParagraphStyle.keepWithNext (boolean)	Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.keepLinesTogether	schema_pii_or_identity_field	Keep Lines Together	ParagraphStyle.keepLinesTogether (boolean)	Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.spacingMode	schema_pii_or_identity_field	Spacing Mode	ParagraphStyle.spacingMode (string)	The spacing mode for the paragraph.
Document.namedStyles.styles.paragraphStyle.lineSpacing	schema_pii_or_identity_field	Line Spacing	ParagraphStyle.lineSpacing (number)	The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.avoidWidowAndOrphan	schema_pii_or_identity_field	Avoid Widow And Orphan	ParagraphStyle.avoidWidowAndOrphan (boolean)	Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
Document.namedStyles.styles.paragraphStyle.spaceBelow	schema_pii_or_identity_field	Space Below	ParagraphStyle.spaceBelow (object)	The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
Document.lists	api_schema_field	Lists	Document.lists (object)	Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this fie…
Document.namedRanges	schema_pii_or_identity_field	Named Ranges	Document.namedRanges (object)	Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset…
Document.documentId	api_schema_field	Document Id	Document.documentId (string)	Output only. The ID of the document.
Document.revisionId	api_schema_field	Revision Id	Document.revisionId (string)	Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit…
Document.suggestedNamedStylesChanges	schema_pii_or_identity_field	Suggested Named Styles Changes	Document.suggestedNamedStylesChanges (object)	Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsConte…
Document.body	api_schema_field	Body	Document.body (object)	Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains inf…
Document.body.content	api_schema_field	Content	Body.content (array)	The contents of the body. The indexes for the body's content begin at zero.
Document.body.content.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
Document.body.content.sectionBreak.sectionStyle	api_schema_field	Section Style	SectionBreak.sectionStyle (object)	The style of the section after this section break.
Document.body.content.sectionBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	SectionBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Document.body.content.sectionBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	SectionBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Document.body.content.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
Document.body.content.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
Document.body.content.tableOfContents.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableOfContents.suggestedInsertionIds (array)	The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
Document.body.content.tableOfContents.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableOfContents.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Document.body.content.tableOfContents.content	api_schema_field	Content	TableOfContents.content (array)	The content of the table of contents.
Document.body.content.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
Document.body.content.table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
Document.body.content.table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Document.body.content.table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
Document.body.content.table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
Document.body.content.table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Document.body.content.table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
Document.body.content.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
Document.body.content.paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
Document.body.content.paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
Document.body.content.paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
Document.body.content.paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
Document.body.content.paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
Document.body.content.paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
Document.body.content.paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
Document.body.content.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
Document.headers	api_schema_field	Headers	Document.headers (object)	Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, th…
Document.positionedObjects	api_schema_field	Positioned Objects	Document.positionedObjects (object)	Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If…
Document.tabs	api_schema_field	Tabs	Document.tabs (array)	Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.
Document.tabs.tabProperties	api_schema_field	Tab Properties	Tab.tabProperties (object)	The properties of the tab, like ID and title.
Document.tabs.tabProperties.tabId	api_schema_field	Tab Id	TabProperties.tabId (string)	The immutable ID of the tab.
Document.tabs.tabProperties.title	api_schema_field	Title	TabProperties.title (string)	The user-visible name of the tab.
Document.tabs.tabProperties.nestingLevel	api_schema_field	Nesting Level	TabProperties.nestingLevel (integer)	Output only. The depth of the tab within the document. Root-level tabs start at 0.
Document.tabs.tabProperties.parentTabId	api_schema_field	Parent Tab Id	TabProperties.parentTabId (string)	Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.
Document.tabs.tabProperties.iconEmoji	api_schema_field	Icon Emoji	TabProperties.iconEmoji (string)	Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value…
Document.tabs.tabProperties.index	api_schema_field	Index	TabProperties.index (integer)	The zero-based index of the tab within the parent.
Document.tabs.documentTab	api_schema_field	Document Tab	Tab.documentTab (object)	A tab with document contents, like text and images.
Document.tabs.documentTab.headers	api_schema_field	Headers	DocumentTab.headers (object)	The headers in the document tab, keyed by header ID.
Document.tabs.documentTab.documentStyle	api_schema_field	Document Style	DocumentTab.documentStyle (object)	The style of the document tab.
Document.tabs.documentTab.documentStyle.marginFooter	api_schema_field	Margin Footer	DocumentStyle.marginFooter (object)	The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.useFirstPageHeaderFooter	api_schema_field	Use First Page Header Footer	DocumentStyle.useFirstPageHeaderFooter (boolean)	Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.marginHeader	api_schema_field	Margin Header	DocumentStyle.marginHeader (object)	The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.marginRight	api_schema_field	Margin Right	DocumentStyle.marginRight (object)	The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.flipPageOrientation	api_schema_field	Flip Page Orientation	DocumentStyle.flipPageOrientation (boolean)	Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.defaultFooterId	api_schema_field	Default Footer Id	DocumentStyle.defaultFooterId (string)	The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
Document.tabs.documentTab.documentStyle.firstPageFooterId	api_schema_field	First Page Footer Id	DocumentStyle.firstPageFooterId (string)	The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If…
Document.tabs.documentTab.documentStyle.background	api_schema_field	Background	DocumentStyle.background (object)	The background of the document. Documents cannot have a transparent background color.
Document.tabs.documentTab.documentStyle.documentFormat	api_schema_field	Document Format	DocumentStyle.documentFormat (object)	Specifies document-level format settings, such as the document mode (pages vs pageless).
Document.tabs.documentTab.documentStyle.marginTop	api_schema_field	Margin Top	DocumentStyle.marginTop (object)	The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.pageNumberStart	api_schema_field	Page Number Start	DocumentStyle.pageNumberStart (integer)	The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.marginBottom	api_schema_field	Margin Bottom	DocumentStyle.marginBottom (object)	The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.defaultHeaderId	api_schema_field	Default Header Id	DocumentStyle.defaultHeaderId (string)	The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.
Document.tabs.documentTab.documentStyle.useEvenPageHeaderFooter	api_schema_field	Use Even Page Header Footer	DocumentStyle.useEvenPageHeaderFooter (boolean)	Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.pageSize	api_schema_field	Page Size	DocumentStyle.pageSize (object)	The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.useCustomHeaderFooterMargins	api_schema_field	Use Custom Header Footer Margins	DocumentStyle.useCustomHeaderFooterMargins (boolean)	Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAG…
Document.tabs.documentTab.documentStyle.evenPageFooterId	api_schema_field	Even Page Footer Id	DocumentStyle.evenPageFooterId (string)	The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this prop…
Document.tabs.documentTab.documentStyle.marginLeft	api_schema_field	Margin Left	DocumentStyle.marginLeft (object)	The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered.
Document.tabs.documentTab.documentStyle.firstPageHeaderId	api_schema_field	First Page Header Id	DocumentStyle.firstPageHeaderId (string)	The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If…
Document.tabs.documentTab.documentStyle.evenPageHeaderId	api_schema_field	Even Page Header Id	DocumentStyle.evenPageHeaderId (string)	The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this prop…
Document.tabs.documentTab.namedStyles	schema_pii_or_identity_field	Named Styles	DocumentTab.namedStyles (object)	The named styles of the document tab.
Document.tabs.documentTab.namedStyles.styles	schema_pii_or_identity_field	Styles	NamedStyles.styles (array)	The named styles. There's an entry for each of the possible named style types.
Document.tabs.documentTab.lists	api_schema_field	Lists	DocumentTab.lists (object)	The lists in the document tab, keyed by list ID.
Document.tabs.documentTab.positionedObjects	api_schema_field	Positioned Objects	DocumentTab.positionedObjects (object)	The positioned objects in the document tab, keyed by object ID.
Document.tabs.documentTab.footnotes	api_schema_field	Footnotes	DocumentTab.footnotes (object)	The footnotes in the document tab, keyed by footnote ID.
Document.tabs.documentTab.inlineObjects	api_schema_field	Inline Objects	DocumentTab.inlineObjects (object)	The inline objects in the document tab, keyed by object ID.
Document.tabs.documentTab.body	api_schema_field	Body	DocumentTab.body (object)	The main body of the document tab.
Document.tabs.documentTab.body.content	api_schema_field	Content	Body.content (array)	The contents of the body. The indexes for the body's content begin at zero.
Document.tabs.documentTab.suggestedDocumentStyleChanges	api_schema_field	Suggested Document Style Changes	DocumentTab.suggestedDocumentStyleChanges (object)	The suggested changes to the style of the document tab, keyed by suggestion ID.
Document.tabs.documentTab.suggestedNamedStylesChanges	schema_pii_or_identity_field	Suggested Named Styles Changes	DocumentTab.suggestedNamedStylesChanges (object)	The suggested changes to the named styles of the document tab, keyed by suggestion ID.
Document.tabs.documentTab.footers	api_schema_field	Footers	DocumentTab.footers (object)	The footers in the document tab, keyed by footer ID.
Document.tabs.documentTab.namedRanges	schema_pii_or_identity_field	Named Ranges	DocumentTab.namedRanges (object)	The named ranges in the document tab, keyed by name.
Document.tabs.childTabs	api_schema_field	Child Tabs	Tab.childTabs (array)	The child tabs nested within this tab.
Document.footers	api_schema_field	Footers	Document.footers (object)	Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, th…
Document.suggestedDocumentStyleChanges	api_schema_field	Suggested Document Style Changes	Document.suggestedDocumentStyleChanges (object)	Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent pa…
Body.content	api_schema_field	Content	Body.content (array)	The contents of the body. The indexes for the body's content begin at zero.
Body.content.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
Body.content.sectionBreak.sectionStyle	api_schema_field	Section Style	SectionBreak.sectionStyle (object)	The style of the section after this section break.
Body.content.sectionBreak.sectionStyle.marginTop	api_schema_field	Margin Top	SectionStyle.marginTop (object)	The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property resu…
Body.content.sectionBreak.sectionStyle.marginBottom	api_schema_field	Margin Bottom	SectionStyle.marginBottom (object)	The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this propert…
Body.content.sectionBreak.sectionStyle.pageNumberStart	api_schema_field	Page Number Start	SectionStyle.pageNumberStart (integer)	The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PA…
Body.content.sectionBreak.sectionStyle.defaultHeaderId	api_schema_field	Default Header Id	SectionStyle.defaultHeaderId (string)	The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not…
Body.content.sectionBreak.sectionStyle.evenPageHeaderId	api_schema_field	Even Page Header Id	SectionStyle.evenPageHeaderId (string)	The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset,…
Body.content.sectionBreak.sectionStyle.firstPageHeaderId	api_schema_field	First Page Header Id	SectionStyle.firstPageHeaderId (string)	The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_i…
Body.content.sectionBreak.sectionStyle.marginLeft	api_schema_field	Margin Left	SectionStyle.marginLeft (object)	The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMo…
Body.content.sectionBreak.sectionStyle.evenPageFooterId	api_schema_field	Even Page Footer Id	SectionStyle.evenPageFooterId (string)	The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset,…
Body.content.sectionBreak.sectionStyle.marginRight	api_schema_field	Margin Right	SectionStyle.marginRight (object)	The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If Documen…
Body.content.sectionBreak.sectionStyle.marginHeader	api_schema_field	Margin Header	SectionStyle.marginHeader (object)	The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a hea…
Body.content.sectionBreak.sectionStyle.useFirstPageHeaderFooter	api_schema_field	Use First Page Header Footer	SectionStyle.useFirstPageHeaderFooter (boolean)	Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interprete…
Body.content.sectionBreak.sectionStyle.marginFooter	api_schema_field	Margin Footer	SectionStyle.marginFooter (object)	The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a foo…
Body.content.sectionBreak.sectionStyle.columnSeparatorStyle	api_schema_field	Column Separator Style	SectionStyle.columnSeparatorStyle (string)	The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
Body.content.sectionBreak.sectionStyle.contentDirection	api_schema_field	Content Direction	SectionStyle.contentDirection (string)	The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
Body.content.sectionBreak.sectionStyle.sectionType	api_schema_field	Section Type	SectionStyle.sectionType (string)	Output only. The type of section.
Body.content.sectionBreak.sectionStyle.columnProperties	api_schema_field	Column Properties	SectionStyle.columnProperties (array)	The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting t…
Body.content.sectionBreak.sectionStyle.flipPageOrientation	api_schema_field	Flip Page Orientation	SectionStyle.flipPageOrientation (boolean)	Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMo…
Body.content.sectionBreak.sectionStyle.defaultFooterId	api_schema_field	Default Footer Id	SectionStyle.defaultFooterId (string)	The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not…
Body.content.sectionBreak.sectionStyle.firstPageFooterId	api_schema_field	First Page Footer Id	SectionStyle.firstPageFooterId (string)	The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_i…
Body.content.sectionBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	SectionBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Body.content.sectionBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	SectionBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Body.content.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
Body.content.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
Body.content.tableOfContents.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableOfContents.suggestedInsertionIds (array)	The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
Body.content.tableOfContents.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableOfContents.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Body.content.tableOfContents.content	api_schema_field	Content	TableOfContents.content (array)	The content of the table of contents.
Body.content.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
Body.content.table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
Body.content.table.tableRows.startIndex	api_schema_field	Start Index	TableRow.startIndex (integer)	The zero-based start index of this row, in UTF-16 code units.
Body.content.table.tableRows.tableCells	api_schema_field	Table Cells	TableRow.tableCells (array)	The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
Body.content.table.tableRows.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableRow.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Body.content.table.tableRows.endIndex	api_schema_field	End Index	TableRow.endIndex (integer)	The zero-based end index of this row, exclusive, in UTF-16 code units.
Body.content.table.tableRows.tableRowStyle	api_schema_field	Table Row Style	TableRow.tableRowStyle (object)	The style of the table row.
Body.content.table.tableRows.suggestedTableRowStyleChanges	api_schema_field	Suggested Table Row Style Changes	TableRow.suggestedTableRowStyleChanges (object)	The suggested style changes to this row, keyed by suggestion ID.
Body.content.table.tableRows.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableRow.suggestedInsertionIds (array)	The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Body.content.table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Body.content.table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
Body.content.table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
Body.content.table.tableStyle.tableColumnProperties	api_schema_field	Table Column Properties	TableStyle.tableColumnProperties (array)	The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
Body.content.table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Body.content.table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
Body.content.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
Body.content.paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
Body.content.paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
Body.content.paragraph.paragraphStyle.borderTop	api_schema_field	Border Top	ParagraphStyle.borderTop (object)	The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph…
Body.content.paragraph.paragraphStyle.borderRight	api_schema_field	Border Right	ParagraphStyle.borderRight (object)	The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Body.content.paragraph.paragraphStyle.shading	api_schema_field	Shading	ParagraphStyle.shading (object)	The shading of the paragraph. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.headingId	api_schema_field	Heading Id	ParagraphStyle.headingId (string)	The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
Body.content.paragraph.paragraphStyle.indentFirstLine	api_schema_field	Indent First Line	ParagraphStyle.indentFirstLine (object)	The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.borderBetween	api_schema_field	Border Between	ParagraphStyle.borderBetween (object)	The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partial…
Body.content.paragraph.paragraphStyle.spaceAbove	api_schema_field	Space Above	ParagraphStyle.spaceAbove (object)	The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.indentStart	api_schema_field	Indent Start	ParagraphStyle.indentStart (object)	The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.tabStops	api_schema_field	Tab Stops	ParagraphStyle.tabStops (array)	A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
Body.content.paragraph.paragraphStyle.namedStyleType	schema_pii_or_identity_field	Named Style Type	ParagraphStyle.namedStyleType (string)	The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
Body.content.paragraph.paragraphStyle.alignment	api_schema_field	Alignment	ParagraphStyle.alignment (string)	The text alignment for this paragraph.
Body.content.paragraph.paragraphStyle.borderLeft	api_schema_field	Border Left	ParagraphStyle.borderLeft (object)	The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Body.content.paragraph.paragraphStyle.indentEnd	api_schema_field	Indent End	ParagraphStyle.indentEnd (object)	The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.pageBreakBefore	api_schema_field	Page Break Before	ParagraphStyle.pageBreakBefore (boolean)	Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can res…
Body.content.paragraph.paragraphStyle.borderBottom	api_schema_field	Border Bottom	ParagraphStyle.borderBottom (object)	The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a par…
Body.content.paragraph.paragraphStyle.direction	api_schema_field	Direction	ParagraphStyle.direction (string)	The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
Body.content.paragraph.paragraphStyle.keepWithNext	api_schema_field	Keep With Next	ParagraphStyle.keepWithNext (boolean)	Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.keepLinesTogether	api_schema_field	Keep Lines Together	ParagraphStyle.keepLinesTogether (boolean)	Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.spacingMode	api_schema_field	Spacing Mode	ParagraphStyle.spacingMode (string)	The spacing mode for the paragraph.
Body.content.paragraph.paragraphStyle.lineSpacing	api_schema_field	Line Spacing	ParagraphStyle.lineSpacing (number)	The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.avoidWidowAndOrphan	api_schema_field	Avoid Widow And Orphan	ParagraphStyle.avoidWidowAndOrphan (boolean)	Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
Body.content.paragraph.paragraphStyle.spaceBelow	api_schema_field	Space Below	ParagraphStyle.spaceBelow (object)	The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
Body.content.paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
Body.content.paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
Body.content.paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
Body.content.paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
Body.content.paragraph.elements.endIndex	api_schema_field	End Index	ParagraphElement.endIndex (integer)	The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
Body.content.paragraph.elements.textRun	api_schema_field	Text Run	ParagraphElement.textRun (object)	A text run paragraph element.
Body.content.paragraph.elements.autoText	api_schema_field	Auto Text	ParagraphElement.autoText (object)	An auto text paragraph element.
Body.content.paragraph.elements.inlineObjectElement	api_schema_field	Inline Object Element	ParagraphElement.inlineObjectElement (object)	An inline object paragraph element.
Body.content.paragraph.elements.dateElement	api_schema_field	Date Element	ParagraphElement.dateElement (object)	A paragraph element that represents a date.
Body.content.paragraph.elements.pageBreak	api_schema_field	Page Break	ParagraphElement.pageBreak (object)	A page break paragraph element.
Body.content.paragraph.elements.columnBreak	api_schema_field	Column Break	ParagraphElement.columnBreak (object)	A column break paragraph element.
Body.content.paragraph.elements.footnoteReference	api_schema_field	Footnote Reference	ParagraphElement.footnoteReference (object)	A footnote reference paragraph element.
Body.content.paragraph.elements.startIndex	api_schema_field	Start Index	ParagraphElement.startIndex (integer)	The zero-based start index of this paragraph element, in UTF-16 code units.
Body.content.paragraph.elements.richLink	api_schema_field	Rich Link	ParagraphElement.richLink (object)	A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
Body.content.paragraph.elements.horizontalRule	api_schema_field	Horizontal Rule	ParagraphElement.horizontalRule (object)	A horizontal rule paragraph element.
Body.content.paragraph.elements.person	api_schema_field	Person	ParagraphElement.person (object)	A paragraph element that links to a person or email address.
Body.content.paragraph.elements.equation	api_schema_field	Equation	ParagraphElement.equation (object)	An equation paragraph element.
Body.content.paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
Body.content.paragraph.bullet.listId	api_schema_field	List Id	Bullet.listId (string)	The ID of the list this paragraph belongs to.
Body.content.paragraph.bullet.nestingLevel	api_schema_field	Nesting Level	Bullet.nestingLevel (integer)	The nesting level of this paragraph in the list.
Body.content.paragraph.bullet.textStyle	api_schema_field	Text Style	Bullet.textStyle (object)	The paragraph-specific text style applied to this bullet.
Body.content.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
StructuralElement.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
StructuralElement.sectionBreak.sectionStyle	api_schema_field	Section Style	SectionBreak.sectionStyle (object)	The style of the section after this section break.
StructuralElement.sectionBreak.sectionStyle.marginTop	api_schema_field	Margin Top	SectionStyle.marginTop (object)	The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property resu…
StructuralElement.sectionBreak.sectionStyle.marginTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.marginBottom	api_schema_field	Margin Bottom	SectionStyle.marginBottom (object)	The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this propert…
StructuralElement.sectionBreak.sectionStyle.marginBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.pageNumberStart	api_schema_field	Page Number Start	SectionStyle.pageNumberStart (integer)	The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PA…
StructuralElement.sectionBreak.sectionStyle.defaultHeaderId	api_schema_field	Default Header Id	SectionStyle.defaultHeaderId (string)	The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not…
StructuralElement.sectionBreak.sectionStyle.evenPageHeaderId	api_schema_field	Even Page Header Id	SectionStyle.evenPageHeaderId (string)	The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset,…
StructuralElement.sectionBreak.sectionStyle.firstPageHeaderId	api_schema_field	First Page Header Id	SectionStyle.firstPageHeaderId (string)	The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_i…
StructuralElement.sectionBreak.sectionStyle.marginLeft	api_schema_field	Margin Left	SectionStyle.marginLeft (object)	The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMo…
StructuralElement.sectionBreak.sectionStyle.marginLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.evenPageFooterId	api_schema_field	Even Page Footer Id	SectionStyle.evenPageFooterId (string)	The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset,…
StructuralElement.sectionBreak.sectionStyle.marginRight	api_schema_field	Margin Right	SectionStyle.marginRight (object)	The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If Documen…
StructuralElement.sectionBreak.sectionStyle.marginRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.marginHeader	api_schema_field	Margin Header	SectionStyle.marginHeader (object)	The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a hea…
StructuralElement.sectionBreak.sectionStyle.marginHeader.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginHeader.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.useFirstPageHeaderFooter	api_schema_field	Use First Page Header Footer	SectionStyle.useFirstPageHeaderFooter (boolean)	Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interprete…
StructuralElement.sectionBreak.sectionStyle.marginFooter	api_schema_field	Margin Footer	SectionStyle.marginFooter (object)	The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a foo…
StructuralElement.sectionBreak.sectionStyle.marginFooter.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.sectionBreak.sectionStyle.marginFooter.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.sectionBreak.sectionStyle.columnSeparatorStyle	api_schema_field	Column Separator Style	SectionStyle.columnSeparatorStyle (string)	The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
StructuralElement.sectionBreak.sectionStyle.contentDirection	api_schema_field	Content Direction	SectionStyle.contentDirection (string)	The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
StructuralElement.sectionBreak.sectionStyle.sectionType	api_schema_field	Section Type	SectionStyle.sectionType (string)	Output only. The type of section.
StructuralElement.sectionBreak.sectionStyle.columnProperties	api_schema_field	Column Properties	SectionStyle.columnProperties (array)	The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting t…
StructuralElement.sectionBreak.sectionStyle.columnProperties.width	api_schema_field	Width	SectionColumnProperties.width (object)	Output only. The width of the column.
StructuralElement.sectionBreak.sectionStyle.columnProperties.paddingEnd	api_schema_field	Padding End	SectionColumnProperties.paddingEnd (object)	The padding at the end of the column.
StructuralElement.sectionBreak.sectionStyle.flipPageOrientation	api_schema_field	Flip Page Orientation	SectionStyle.flipPageOrientation (boolean)	Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMo…
StructuralElement.sectionBreak.sectionStyle.defaultFooterId	api_schema_field	Default Footer Id	SectionStyle.defaultFooterId (string)	The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not…
StructuralElement.sectionBreak.sectionStyle.firstPageFooterId	api_schema_field	First Page Footer Id	SectionStyle.firstPageFooterId (string)	The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_i…
StructuralElement.sectionBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	SectionBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.sectionBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	SectionBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
StructuralElement.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
StructuralElement.tableOfContents.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableOfContents.suggestedInsertionIds (array)	The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.tableOfContents.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableOfContents.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.tableOfContents.content	api_schema_field	Content	TableOfContents.content (array)	The content of the table of contents.
StructuralElement.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
StructuralElement.table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
StructuralElement.table.tableRows.startIndex	api_schema_field	Start Index	TableRow.startIndex (integer)	The zero-based start index of this row, in UTF-16 code units.
StructuralElement.table.tableRows.tableCells	api_schema_field	Table Cells	TableRow.tableCells (array)	The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
StructuralElement.table.tableRows.tableCells.content	api_schema_field	Content	TableCell.content (array)	The content of the cell.
StructuralElement.table.tableRows.tableCells.startIndex	api_schema_field	Start Index	TableCell.startIndex (integer)	The zero-based start index of this cell, in UTF-16 code units.
StructuralElement.table.tableRows.tableCells.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableCell.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.table.tableRows.tableCells.suggestedTableCellStyleChanges	api_schema_field	Suggested Table Cell Style Changes	TableCell.suggestedTableCellStyleChanges (object)	The suggested changes to the table cell style, keyed by suggestion ID.
StructuralElement.table.tableRows.tableCells.endIndex	api_schema_field	End Index	TableCell.endIndex (integer)	The zero-based end index of this cell, exclusive, in UTF-16 code units.
StructuralElement.table.tableRows.tableCells.tableCellStyle	api_schema_field	Table Cell Style	TableCell.tableCellStyle (object)	The style of the cell.
StructuralElement.table.tableRows.tableCells.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableCell.suggestedInsertionIds (array)	The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.table.tableRows.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableRow.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.table.tableRows.endIndex	api_schema_field	End Index	TableRow.endIndex (integer)	The zero-based end index of this row, exclusive, in UTF-16 code units.
StructuralElement.table.tableRows.tableRowStyle	api_schema_field	Table Row Style	TableRow.tableRowStyle (object)	The style of the table row.
StructuralElement.table.tableRows.tableRowStyle.minRowHeight	api_schema_field	Min Row Height	TableRowStyle.minRowHeight (object)	The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
StructuralElement.table.tableRows.tableRowStyle.preventOverflow	api_schema_field	Prevent Overflow	TableRowStyle.preventOverflow (boolean)	Whether the row cannot overflow across page or column boundaries.
StructuralElement.table.tableRows.tableRowStyle.tableHeader	api_schema_field	Table Header	TableRowStyle.tableHeader (boolean)	Whether the row is a table header.
StructuralElement.table.tableRows.suggestedTableRowStyleChanges	api_schema_field	Suggested Table Row Style Changes	TableRow.suggestedTableRowStyleChanges (object)	The suggested style changes to this row, keyed by suggestion ID.
StructuralElement.table.tableRows.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableRow.suggestedInsertionIds (array)	The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
StructuralElement.table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
StructuralElement.table.tableStyle.tableColumnProperties	api_schema_field	Table Column Properties	TableStyle.tableColumnProperties (array)	The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
StructuralElement.table.tableStyle.tableColumnProperties.widthType	api_schema_field	Width Type	TableColumnProperties.widthType (string)	The width type of the column.
StructuralElement.table.tableStyle.tableColumnProperties.width	api_schema_field	Width	TableColumnProperties.width (object)	The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
StructuralElement.table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
StructuralElement.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
StructuralElement.paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
StructuralElement.paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
StructuralElement.paragraph.paragraphStyle.borderTop	api_schema_field	Border Top	ParagraphStyle.borderTop (object)	The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph…
StructuralElement.paragraph.paragraphStyle.borderTop.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
StructuralElement.paragraph.paragraphStyle.borderTop.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
StructuralElement.paragraph.paragraphStyle.borderTop.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
StructuralElement.paragraph.paragraphStyle.borderTop.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
StructuralElement.paragraph.paragraphStyle.borderRight	api_schema_field	Border Right	ParagraphStyle.borderRight (object)	The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
StructuralElement.paragraph.paragraphStyle.borderRight.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
StructuralElement.paragraph.paragraphStyle.borderRight.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
StructuralElement.paragraph.paragraphStyle.borderRight.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
StructuralElement.paragraph.paragraphStyle.borderRight.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
StructuralElement.paragraph.paragraphStyle.shading	api_schema_field	Shading	ParagraphStyle.shading (object)	The shading of the paragraph. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.shading.backgroundColor	api_schema_field	Background Color	Shading.backgroundColor (object)	The background color of this paragraph shading.
StructuralElement.paragraph.paragraphStyle.headingId	api_schema_field	Heading Id	ParagraphStyle.headingId (string)	The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
StructuralElement.paragraph.paragraphStyle.indentFirstLine	api_schema_field	Indent First Line	ParagraphStyle.indentFirstLine (object)	The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.indentFirstLine.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.paragraph.paragraphStyle.indentFirstLine.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.paragraph.paragraphStyle.borderBetween	api_schema_field	Border Between	ParagraphStyle.borderBetween (object)	The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partial…
StructuralElement.paragraph.paragraphStyle.borderBetween.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
StructuralElement.paragraph.paragraphStyle.borderBetween.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
StructuralElement.paragraph.paragraphStyle.borderBetween.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
StructuralElement.paragraph.paragraphStyle.borderBetween.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
StructuralElement.paragraph.paragraphStyle.spaceAbove	api_schema_field	Space Above	ParagraphStyle.spaceAbove (object)	The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.spaceAbove.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.paragraph.paragraphStyle.spaceAbove.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.paragraph.paragraphStyle.indentStart	api_schema_field	Indent Start	ParagraphStyle.indentStart (object)	The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.indentStart.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.paragraph.paragraphStyle.indentStart.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.paragraph.paragraphStyle.tabStops	api_schema_field	Tab Stops	ParagraphStyle.tabStops (array)	A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
StructuralElement.paragraph.paragraphStyle.tabStops.offset	api_schema_field	Offset	TabStop.offset (object)	The offset between this tab stop and the start margin.
StructuralElement.paragraph.paragraphStyle.tabStops.alignment	api_schema_field	Alignment	TabStop.alignment (string)	The alignment of this tab stop. If unset, the value defaults to START.
StructuralElement.paragraph.paragraphStyle.namedStyleType	schema_pii_or_identity_field	Named Style Type	ParagraphStyle.namedStyleType (string)	The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
StructuralElement.paragraph.paragraphStyle.alignment	api_schema_field	Alignment	ParagraphStyle.alignment (string)	The text alignment for this paragraph.
StructuralElement.paragraph.paragraphStyle.borderLeft	api_schema_field	Border Left	ParagraphStyle.borderLeft (object)	The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
StructuralElement.paragraph.paragraphStyle.borderLeft.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
StructuralElement.paragraph.paragraphStyle.borderLeft.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
StructuralElement.paragraph.paragraphStyle.borderLeft.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
StructuralElement.paragraph.paragraphStyle.borderLeft.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
StructuralElement.paragraph.paragraphStyle.indentEnd	api_schema_field	Indent End	ParagraphStyle.indentEnd (object)	The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.indentEnd.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.paragraph.paragraphStyle.indentEnd.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.paragraph.paragraphStyle.pageBreakBefore	api_schema_field	Page Break Before	ParagraphStyle.pageBreakBefore (boolean)	Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can res…
StructuralElement.paragraph.paragraphStyle.borderBottom	api_schema_field	Border Bottom	ParagraphStyle.borderBottom (object)	The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a par…
StructuralElement.paragraph.paragraphStyle.borderBottom.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
StructuralElement.paragraph.paragraphStyle.borderBottom.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
StructuralElement.paragraph.paragraphStyle.borderBottom.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
StructuralElement.paragraph.paragraphStyle.borderBottom.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
StructuralElement.paragraph.paragraphStyle.direction	api_schema_field	Direction	ParagraphStyle.direction (string)	The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
StructuralElement.paragraph.paragraphStyle.keepWithNext	api_schema_field	Keep With Next	ParagraphStyle.keepWithNext (boolean)	Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.keepLinesTogether	api_schema_field	Keep Lines Together	ParagraphStyle.keepLinesTogether (boolean)	Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.spacingMode	api_schema_field	Spacing Mode	ParagraphStyle.spacingMode (string)	The spacing mode for the paragraph.
StructuralElement.paragraph.paragraphStyle.lineSpacing	api_schema_field	Line Spacing	ParagraphStyle.lineSpacing (number)	The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.avoidWidowAndOrphan	api_schema_field	Avoid Widow And Orphan	ParagraphStyle.avoidWidowAndOrphan (boolean)	Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.spaceBelow	api_schema_field	Space Below	ParagraphStyle.spaceBelow (object)	The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
StructuralElement.paragraph.paragraphStyle.spaceBelow.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
StructuralElement.paragraph.paragraphStyle.spaceBelow.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
StructuralElement.paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
StructuralElement.paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
StructuralElement.paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
StructuralElement.paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
StructuralElement.paragraph.elements.endIndex	api_schema_field	End Index	ParagraphElement.endIndex (integer)	The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
StructuralElement.paragraph.elements.textRun	api_schema_field	Text Run	ParagraphElement.textRun (object)	A text run paragraph element.
StructuralElement.paragraph.elements.textRun.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TextRun.suggestedInsertionIds (array)	The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.textRun.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	TextRun.suggestedTextStyleChanges (object)	The suggested text style changes to this run, keyed by suggestion ID.
StructuralElement.paragraph.elements.textRun.textStyle	api_schema_field	Text Style	TextRun.textStyle (object)	The text style of this run.
StructuralElement.paragraph.elements.textRun.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TextRun.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.textRun.content	api_schema_field	Content	TextRun.content (string)	The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
StructuralElement.paragraph.elements.autoText	api_schema_field	Auto Text	ParagraphElement.autoText (object)	An auto text paragraph element.
StructuralElement.paragraph.elements.autoText.type	api_schema_field	Type	AutoText.type (string)	The type of this auto text.
StructuralElement.paragraph.elements.autoText.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	AutoText.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.autoText.textStyle	api_schema_field	Text Style	AutoText.textStyle (object)	The text style of this AutoText.
StructuralElement.paragraph.elements.autoText.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	AutoText.suggestedInsertionIds (array)	The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.autoText.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	AutoText.suggestedTextStyleChanges (object)	The suggested text style changes to this AutoText, keyed by suggestion ID.
StructuralElement.paragraph.elements.inlineObjectElement	api_schema_field	Inline Object Element	ParagraphElement.inlineObjectElement (object)	An inline object paragraph element.
StructuralElement.paragraph.elements.inlineObjectElement.textStyle	api_schema_field	Text Style	InlineObjectElement.textStyle (object)	The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
StructuralElement.paragraph.elements.inlineObjectElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	InlineObjectElement.suggestedInsertionIds (array)	The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.inlineObjectElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	InlineObjectElement.suggestedTextStyleChanges (object)	The suggested text style changes to this InlineObject, keyed by suggestion ID.
StructuralElement.paragraph.elements.inlineObjectElement.inlineObjectId	api_schema_field	Inline Object Id	InlineObjectElement.inlineObjectId (string)	The ID of the InlineObject this element contains.
StructuralElement.paragraph.elements.inlineObjectElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	InlineObjectElement.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.dateElement	api_schema_field	Date Element	ParagraphElement.dateElement (object)	A paragraph element that represents a date.
StructuralElement.paragraph.elements.dateElement.suggestedDateElementPropertiesChanges	api_schema_field	Suggested Date Element Properties Changes	DateElement.suggestedDateElementPropertiesChanges (object)	The suggested changes to the date element properties, keyed by suggestion ID.
StructuralElement.paragraph.elements.dateElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	DateElement.suggestedInsertionIds (array)	IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested…
StructuralElement.paragraph.elements.dateElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	DateElement.suggestedTextStyleChanges (object)	The suggested text style changes to this DateElement, keyed by suggestion ID.
StructuralElement.paragraph.elements.dateElement.textStyle	api_schema_field	Text Style	DateElement.textStyle (object)	The text style of this DateElement.
StructuralElement.paragraph.elements.dateElement.dateElementProperties	api_schema_field	Date Element Properties	DateElement.dateElementProperties (object)	The properties of this DateElement.
StructuralElement.paragraph.elements.dateElement.dateId	api_schema_field	Date Id	DateElement.dateId (string)	Output only. The unique ID of this date.
StructuralElement.paragraph.elements.dateElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	DateElement.suggestedDeletionIds (array)	IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.
StructuralElement.paragraph.elements.pageBreak	api_schema_field	Page Break	ParagraphElement.pageBreak (object)	A page break paragraph element.
StructuralElement.paragraph.elements.pageBreak.textStyle	api_schema_field	Text Style	PageBreak.textStyle (object)	The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
StructuralElement.paragraph.elements.pageBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	PageBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.pageBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	PageBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.pageBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	PageBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this PageBreak, keyed by suggestion ID.
StructuralElement.paragraph.elements.columnBreak	api_schema_field	Column Break	ParagraphElement.columnBreak (object)	A column break paragraph element.
StructuralElement.paragraph.elements.columnBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	ColumnBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.columnBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	ColumnBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.columnBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	ColumnBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
StructuralElement.paragraph.elements.columnBreak.textStyle	api_schema_field	Text Style	ColumnBreak.textStyle (object)	The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
StructuralElement.paragraph.elements.footnoteReference	api_schema_field	Footnote Reference	ParagraphElement.footnoteReference (object)	A footnote reference paragraph element.
StructuralElement.paragraph.elements.footnoteReference.footnoteId	api_schema_field	Footnote Id	FootnoteReference.footnoteId (string)	The ID of the footnote that contains the content of this footnote reference.
StructuralElement.paragraph.elements.footnoteReference.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	FootnoteReference.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.footnoteReference.textStyle	api_schema_field	Text Style	FootnoteReference.textStyle (object)	The text style of this FootnoteReference.
StructuralElement.paragraph.elements.footnoteReference.footnoteNumber	api_schema_field	Footnote Number	FootnoteReference.footnoteNumber (string)	The rendered number of this footnote.
StructuralElement.paragraph.elements.footnoteReference.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	FootnoteReference.suggestedInsertionIds (array)	The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.footnoteReference.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	FootnoteReference.suggestedTextStyleChanges (object)	The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
StructuralElement.paragraph.elements.startIndex	api_schema_field	Start Index	ParagraphElement.startIndex (integer)	The zero-based start index of this paragraph element, in UTF-16 code units.
StructuralElement.paragraph.elements.richLink	api_schema_field	Rich Link	ParagraphElement.richLink (object)	A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
StructuralElement.paragraph.elements.richLink.textStyle	api_schema_field	Text Style	RichLink.textStyle (object)	The text style of this RichLink.
StructuralElement.paragraph.elements.richLink.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	RichLink.suggestedInsertionIds (array)	IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a sugge…
StructuralElement.paragraph.elements.richLink.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	RichLink.suggestedTextStyleChanges (object)	The suggested text style changes to this RichLink, keyed by suggestion ID.
StructuralElement.paragraph.elements.richLink.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	RichLink.suggestedDeletionIds (array)	IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
StructuralElement.paragraph.elements.richLink.richLinkId	api_schema_field	Rich Link Id	RichLink.richLinkId (string)	Output only. The ID of this link.
StructuralElement.paragraph.elements.richLink.richLinkProperties	api_schema_field	Rich Link Properties	RichLink.richLinkProperties (object)	Output only. The properties of this RichLink. This field is always present.
StructuralElement.paragraph.elements.horizontalRule	api_schema_field	Horizontal Rule	ParagraphElement.horizontalRule (object)	A horizontal rule paragraph element.
StructuralElement.paragraph.elements.horizontalRule.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	HorizontalRule.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.horizontalRule.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	HorizontalRule.suggestedInsertionIds (array)	The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.elements.horizontalRule.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	HorizontalRule.suggestedTextStyleChanges (object)	The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
StructuralElement.paragraph.elements.horizontalRule.textStyle	api_schema_field	Text Style	HorizontalRule.textStyle (object)	The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
StructuralElement.paragraph.elements.person	api_schema_field	Person	ParagraphElement.person (object)	A paragraph element that links to a person or email address.
StructuralElement.paragraph.elements.person.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Person.suggestedDeletionIds (array)	IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
StructuralElement.paragraph.elements.person.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Person.suggestedInsertionIds (array)	IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a…
StructuralElement.paragraph.elements.person.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	Person.suggestedTextStyleChanges (object)	The suggested text style changes to this Person, keyed by suggestion ID.
StructuralElement.paragraph.elements.person.personId	api_schema_field	Person Id	Person.personId (string)	Output only. The unique ID of this link.
StructuralElement.paragraph.elements.person.personProperties	api_schema_field	Person Properties	Person.personProperties (object)	Output only. The properties of this Person. This field is always present.
StructuralElement.paragraph.elements.person.textStyle	api_schema_field	Text Style	Person.textStyle (object)	The text style of this Person.
StructuralElement.paragraph.elements.equation	api_schema_field	Equation	ParagraphElement.equation (object)	An equation paragraph element.
StructuralElement.paragraph.elements.equation.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Equation.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
StructuralElement.paragraph.elements.equation.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Equation.suggestedInsertionIds (array)	The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
StructuralElement.paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
StructuralElement.paragraph.bullet.listId	api_schema_field	List Id	Bullet.listId (string)	The ID of the list this paragraph belongs to.
StructuralElement.paragraph.bullet.nestingLevel	api_schema_field	Nesting Level	Bullet.nestingLevel (integer)	The nesting level of this paragraph in the list.
StructuralElement.paragraph.bullet.textStyle	api_schema_field	Text Style	Bullet.textStyle (object)	The paragraph-specific text style applied to this bullet.
StructuralElement.paragraph.bullet.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
StructuralElement.paragraph.bullet.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
StructuralElement.paragraph.bullet.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
StructuralElement.paragraph.bullet.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
StructuralElement.paragraph.bullet.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
StructuralElement.paragraph.bullet.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
StructuralElement.paragraph.bullet.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
StructuralElement.paragraph.bullet.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
StructuralElement.paragraph.bullet.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
StructuralElement.paragraph.bullet.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
StructuralElement.paragraph.bullet.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
StructuralElement.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
Paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
Paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
Paragraph.paragraphStyle.borderTop	api_schema_field	Border Top	ParagraphStyle.borderTop (object)	The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph…
Paragraph.paragraphStyle.borderTop.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
Paragraph.paragraphStyle.borderTop.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.borderTop.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
Paragraph.paragraphStyle.borderTop.padding.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderTop.padding.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderTop.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
Paragraph.paragraphStyle.borderTop.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
Paragraph.paragraphStyle.borderTop.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderTop.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderRight	api_schema_field	Border Right	ParagraphStyle.borderRight (object)	The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Paragraph.paragraphStyle.borderRight.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
Paragraph.paragraphStyle.borderRight.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.borderRight.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
Paragraph.paragraphStyle.borderRight.padding.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderRight.padding.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderRight.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
Paragraph.paragraphStyle.borderRight.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
Paragraph.paragraphStyle.borderRight.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderRight.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.shading	api_schema_field	Shading	ParagraphStyle.shading (object)	The shading of the paragraph. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.shading.backgroundColor	api_schema_field	Background Color	Shading.backgroundColor (object)	The background color of this paragraph shading.
Paragraph.paragraphStyle.shading.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.headingId	api_schema_field	Heading Id	ParagraphStyle.headingId (string)	The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
Paragraph.paragraphStyle.indentFirstLine	api_schema_field	Indent First Line	ParagraphStyle.indentFirstLine (object)	The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.indentFirstLine.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.indentFirstLine.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderBetween	api_schema_field	Border Between	ParagraphStyle.borderBetween (object)	The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partial…
Paragraph.paragraphStyle.borderBetween.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
Paragraph.paragraphStyle.borderBetween.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.borderBetween.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
Paragraph.paragraphStyle.borderBetween.padding.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderBetween.padding.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderBetween.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
Paragraph.paragraphStyle.borderBetween.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
Paragraph.paragraphStyle.borderBetween.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderBetween.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.spaceAbove	api_schema_field	Space Above	ParagraphStyle.spaceAbove (object)	The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.spaceAbove.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.spaceAbove.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.indentStart	api_schema_field	Indent Start	ParagraphStyle.indentStart (object)	The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.indentStart.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.indentStart.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.tabStops	api_schema_field	Tab Stops	ParagraphStyle.tabStops (array)	A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
Paragraph.paragraphStyle.tabStops.offset	api_schema_field	Offset	TabStop.offset (object)	The offset between this tab stop and the start margin.
Paragraph.paragraphStyle.tabStops.offset.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.tabStops.offset.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.tabStops.alignment	api_schema_field	Alignment	TabStop.alignment (string)	The alignment of this tab stop. If unset, the value defaults to START.
Paragraph.paragraphStyle.namedStyleType	schema_pii_or_identity_field	Named Style Type	ParagraphStyle.namedStyleType (string)	The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
Paragraph.paragraphStyle.alignment	api_schema_field	Alignment	ParagraphStyle.alignment (string)	The text alignment for this paragraph.
Paragraph.paragraphStyle.borderLeft	api_schema_field	Border Left	ParagraphStyle.borderLeft (object)	The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
Paragraph.paragraphStyle.borderLeft.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
Paragraph.paragraphStyle.borderLeft.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.borderLeft.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
Paragraph.paragraphStyle.borderLeft.padding.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderLeft.padding.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderLeft.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
Paragraph.paragraphStyle.borderLeft.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
Paragraph.paragraphStyle.borderLeft.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderLeft.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.indentEnd	api_schema_field	Indent End	ParagraphStyle.indentEnd (object)	The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.indentEnd.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.indentEnd.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.pageBreakBefore	api_schema_field	Page Break Before	ParagraphStyle.pageBreakBefore (boolean)	Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can res…
Paragraph.paragraphStyle.borderBottom	api_schema_field	Border Bottom	ParagraphStyle.borderBottom (object)	The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a par…
Paragraph.paragraphStyle.borderBottom.color	api_schema_field	Color	ParagraphBorder.color (object)	The color of the border.
Paragraph.paragraphStyle.borderBottom.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.paragraphStyle.borderBottom.padding	api_schema_field	Padding	ParagraphBorder.padding (object)	The padding of the border.
Paragraph.paragraphStyle.borderBottom.padding.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderBottom.padding.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.borderBottom.dashStyle	api_schema_field	Dash Style	ParagraphBorder.dashStyle (string)	The dash style of the border.
Paragraph.paragraphStyle.borderBottom.width	api_schema_field	Width	ParagraphBorder.width (object)	The width of the border.
Paragraph.paragraphStyle.borderBottom.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.borderBottom.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.paragraphStyle.direction	api_schema_field	Direction	ParagraphStyle.direction (string)	The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
Paragraph.paragraphStyle.keepWithNext	api_schema_field	Keep With Next	ParagraphStyle.keepWithNext (boolean)	Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.keepLinesTogether	api_schema_field	Keep Lines Together	ParagraphStyle.keepLinesTogether (boolean)	Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.spacingMode	api_schema_field	Spacing Mode	ParagraphStyle.spacingMode (string)	The spacing mode for the paragraph.
Paragraph.paragraphStyle.lineSpacing	api_schema_field	Line Spacing	ParagraphStyle.lineSpacing (number)	The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.avoidWidowAndOrphan	api_schema_field	Avoid Widow And Orphan	ParagraphStyle.avoidWidowAndOrphan (boolean)	Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.spaceBelow	api_schema_field	Space Below	ParagraphStyle.spaceBelow (object)	The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
Paragraph.paragraphStyle.spaceBelow.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.paragraphStyle.spaceBelow.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
Paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
Paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
Paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
Paragraph.elements.endIndex	api_schema_field	End Index	ParagraphElement.endIndex (integer)	The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
Paragraph.elements.textRun	api_schema_field	Text Run	ParagraphElement.textRun (object)	A text run paragraph element.
Paragraph.elements.textRun.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TextRun.suggestedInsertionIds (array)	The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.textRun.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	TextRun.suggestedTextStyleChanges (object)	The suggested text style changes to this run, keyed by suggestion ID.
Paragraph.elements.textRun.textStyle	api_schema_field	Text Style	TextRun.textStyle (object)	The text style of this run.
Paragraph.elements.textRun.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.textRun.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.textRun.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.textRun.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.textRun.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.textRun.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.textRun.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.textRun.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.textRun.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.textRun.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.textRun.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.textRun.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TextRun.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.textRun.content	api_schema_field	Content	TextRun.content (string)	The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
Paragraph.elements.autoText	api_schema_field	Auto Text	ParagraphElement.autoText (object)	An auto text paragraph element.
Paragraph.elements.autoText.type	api_schema_field	Type	AutoText.type (string)	The type of this auto text.
Paragraph.elements.autoText.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	AutoText.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.autoText.textStyle	api_schema_field	Text Style	AutoText.textStyle (object)	The text style of this AutoText.
Paragraph.elements.autoText.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.autoText.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.autoText.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.autoText.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.autoText.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.autoText.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.autoText.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.autoText.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.autoText.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.autoText.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.autoText.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.autoText.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	AutoText.suggestedInsertionIds (array)	The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.autoText.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	AutoText.suggestedTextStyleChanges (object)	The suggested text style changes to this AutoText, keyed by suggestion ID.
Paragraph.elements.inlineObjectElement	api_schema_field	Inline Object Element	ParagraphElement.inlineObjectElement (object)	An inline object paragraph element.
Paragraph.elements.inlineObjectElement.textStyle	api_schema_field	Text Style	InlineObjectElement.textStyle (object)	The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
Paragraph.elements.inlineObjectElement.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.inlineObjectElement.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.inlineObjectElement.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.inlineObjectElement.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.inlineObjectElement.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.inlineObjectElement.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.inlineObjectElement.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.inlineObjectElement.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.inlineObjectElement.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.inlineObjectElement.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.inlineObjectElement.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.inlineObjectElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	InlineObjectElement.suggestedInsertionIds (array)	The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.inlineObjectElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	InlineObjectElement.suggestedTextStyleChanges (object)	The suggested text style changes to this InlineObject, keyed by suggestion ID.
Paragraph.elements.inlineObjectElement.inlineObjectId	api_schema_field	Inline Object Id	InlineObjectElement.inlineObjectId (string)	The ID of the InlineObject this element contains.
Paragraph.elements.inlineObjectElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	InlineObjectElement.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.dateElement	api_schema_field	Date Element	ParagraphElement.dateElement (object)	A paragraph element that represents a date.
Paragraph.elements.dateElement.suggestedDateElementPropertiesChanges	api_schema_field	Suggested Date Element Properties Changes	DateElement.suggestedDateElementPropertiesChanges (object)	The suggested changes to the date element properties, keyed by suggestion ID.
Paragraph.elements.dateElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	DateElement.suggestedInsertionIds (array)	IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested…
Paragraph.elements.dateElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	DateElement.suggestedTextStyleChanges (object)	The suggested text style changes to this DateElement, keyed by suggestion ID.
Paragraph.elements.dateElement.textStyle	api_schema_field	Text Style	DateElement.textStyle (object)	The text style of this DateElement.
Paragraph.elements.dateElement.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.dateElement.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.dateElement.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.dateElement.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.dateElement.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.dateElement.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.dateElement.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.dateElement.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.dateElement.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.dateElement.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.dateElement.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.dateElement.dateElementProperties	api_schema_field	Date Element Properties	DateElement.dateElementProperties (object)	The properties of this DateElement.
Paragraph.elements.dateElement.dateElementProperties.timeFormat	api_schema_field	Time Format	DateElementProperties.timeFormat (string)	Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.
Paragraph.elements.dateElement.dateElementProperties.displayText	api_schema_field	Display Text	DateElementProperties.displayText (string)	Output only. Indicates how the DateElement is displayed in the document.
Paragraph.elements.dateElement.dateElementProperties.timestamp	api_schema_field	Timestamp	DateElementProperties.timestamp (string)	The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000`…
Paragraph.elements.dateElement.dateElementProperties.dateFormat	api_schema_field	Date Format	DateElementProperties.dateFormat (string)	Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent.
Paragraph.elements.dateElement.dateElementProperties.timeZoneId	api_schema_field	Time Zone Id	DateElementProperties.timeZoneId (string)	The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`.
Paragraph.elements.dateElement.dateElementProperties.locale	api_schema_field	Locale	DateElementProperties.locale (string)	The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`,…
Paragraph.elements.dateElement.dateId	api_schema_field	Date Id	DateElement.dateId (string)	Output only. The unique ID of this date.
Paragraph.elements.dateElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	DateElement.suggestedDeletionIds (array)	IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.
Paragraph.elements.pageBreak	api_schema_field	Page Break	ParagraphElement.pageBreak (object)	A page break paragraph element.
Paragraph.elements.pageBreak.textStyle	api_schema_field	Text Style	PageBreak.textStyle (object)	The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
Paragraph.elements.pageBreak.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.pageBreak.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.pageBreak.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.pageBreak.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.pageBreak.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.pageBreak.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.pageBreak.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.pageBreak.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.pageBreak.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.pageBreak.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.pageBreak.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.pageBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	PageBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.pageBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	PageBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.pageBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	PageBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this PageBreak, keyed by suggestion ID.
Paragraph.elements.columnBreak	api_schema_field	Column Break	ParagraphElement.columnBreak (object)	A column break paragraph element.
Paragraph.elements.columnBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	ColumnBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.columnBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	ColumnBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.columnBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	ColumnBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
Paragraph.elements.columnBreak.textStyle	api_schema_field	Text Style	ColumnBreak.textStyle (object)	The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
Paragraph.elements.columnBreak.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.columnBreak.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.columnBreak.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.columnBreak.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.columnBreak.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.columnBreak.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.columnBreak.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.columnBreak.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.columnBreak.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.columnBreak.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.columnBreak.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.footnoteReference	api_schema_field	Footnote Reference	ParagraphElement.footnoteReference (object)	A footnote reference paragraph element.
Paragraph.elements.footnoteReference.footnoteId	api_schema_field	Footnote Id	FootnoteReference.footnoteId (string)	The ID of the footnote that contains the content of this footnote reference.
Paragraph.elements.footnoteReference.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	FootnoteReference.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.footnoteReference.textStyle	api_schema_field	Text Style	FootnoteReference.textStyle (object)	The text style of this FootnoteReference.
Paragraph.elements.footnoteReference.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.footnoteReference.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.footnoteReference.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.footnoteReference.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.footnoteReference.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.footnoteReference.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.footnoteReference.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.footnoteReference.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.footnoteReference.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.footnoteReference.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.footnoteReference.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.footnoteReference.footnoteNumber	api_schema_field	Footnote Number	FootnoteReference.footnoteNumber (string)	The rendered number of this footnote.
Paragraph.elements.footnoteReference.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	FootnoteReference.suggestedInsertionIds (array)	The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.footnoteReference.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	FootnoteReference.suggestedTextStyleChanges (object)	The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
Paragraph.elements.startIndex	api_schema_field	Start Index	ParagraphElement.startIndex (integer)	The zero-based start index of this paragraph element, in UTF-16 code units.
Paragraph.elements.richLink	api_schema_field	Rich Link	ParagraphElement.richLink (object)	A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
Paragraph.elements.richLink.textStyle	api_schema_field	Text Style	RichLink.textStyle (object)	The text style of this RichLink.
Paragraph.elements.richLink.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.richLink.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.richLink.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.richLink.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.richLink.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.richLink.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.richLink.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.richLink.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.richLink.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.richLink.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.richLink.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.richLink.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	RichLink.suggestedInsertionIds (array)	IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a sugge…
Paragraph.elements.richLink.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	RichLink.suggestedTextStyleChanges (object)	The suggested text style changes to this RichLink, keyed by suggestion ID.
Paragraph.elements.richLink.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	RichLink.suggestedDeletionIds (array)	IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
Paragraph.elements.richLink.richLinkId	api_schema_field	Rich Link Id	RichLink.richLinkId (string)	Output only. The ID of this link.
Paragraph.elements.richLink.richLinkProperties	api_schema_field	Rich Link Properties	RichLink.richLinkProperties (object)	Output only. The properties of this RichLink. This field is always present.
Paragraph.elements.richLink.richLinkProperties.uri	api_schema_field	Uri	RichLinkProperties.uri (string)	The URI to the RichLink. This is always present.
Paragraph.elements.richLink.richLinkProperties.title	api_schema_field	Title	RichLinkProperties.title (string)	The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
Paragraph.elements.richLink.richLinkProperties.mimeType	api_schema_field	Mime Type	RichLinkProperties.mimeType (string)	The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
Paragraph.elements.horizontalRule	api_schema_field	Horizontal Rule	ParagraphElement.horizontalRule (object)	A horizontal rule paragraph element.
Paragraph.elements.horizontalRule.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	HorizontalRule.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.horizontalRule.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	HorizontalRule.suggestedInsertionIds (array)	The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.elements.horizontalRule.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	HorizontalRule.suggestedTextStyleChanges (object)	The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
Paragraph.elements.horizontalRule.textStyle	api_schema_field	Text Style	HorizontalRule.textStyle (object)	The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
Paragraph.elements.horizontalRule.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.horizontalRule.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.horizontalRule.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.horizontalRule.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.horizontalRule.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.horizontalRule.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.horizontalRule.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.horizontalRule.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.horizontalRule.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.horizontalRule.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.horizontalRule.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.person	api_schema_field	Person	ParagraphElement.person (object)	A paragraph element that links to a person or email address.
Paragraph.elements.person.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Person.suggestedDeletionIds (array)	IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
Paragraph.elements.person.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Person.suggestedInsertionIds (array)	IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a…
Paragraph.elements.person.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	Person.suggestedTextStyleChanges (object)	The suggested text style changes to this Person, keyed by suggestion ID.
Paragraph.elements.person.personId	api_schema_field	Person Id	Person.personId (string)	Output only. The unique ID of this link.
Paragraph.elements.person.personProperties	api_schema_field	Person Properties	Person.personProperties (object)	Output only. The properties of this Person. This field is always present.
Paragraph.elements.person.personProperties.name	schema_pii_or_identity_field	Name	PersonProperties.name (string)	The name of the person if it's displayed in the link text instead of the person's email address.
Paragraph.elements.person.personProperties.email	schema_pii_or_identity_field	Email	PersonProperties.email (string)	The email address linked to this Person. This field is always present.
Paragraph.elements.person.textStyle	api_schema_field	Text Style	Person.textStyle (object)	The text style of this Person.
Paragraph.elements.person.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.person.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.elements.person.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.elements.person.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.elements.person.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.elements.person.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.elements.person.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.elements.person.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.elements.person.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.elements.person.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.elements.person.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Paragraph.elements.equation	api_schema_field	Equation	ParagraphElement.equation (object)	An equation paragraph element.
Paragraph.elements.equation.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Equation.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Paragraph.elements.equation.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Equation.suggestedInsertionIds (array)	The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
Paragraph.bullet.listId	api_schema_field	List Id	Bullet.listId (string)	The ID of the list this paragraph belongs to.
Paragraph.bullet.nestingLevel	api_schema_field	Nesting Level	Bullet.nestingLevel (integer)	The nesting level of this paragraph in the list.
Paragraph.bullet.textStyle	api_schema_field	Text Style	Bullet.textStyle (object)	The paragraph-specific text style applied to this bullet.
Paragraph.bullet.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.bullet.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.bullet.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
Paragraph.bullet.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
Paragraph.bullet.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
Paragraph.bullet.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
Paragraph.bullet.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
Paragraph.bullet.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Paragraph.bullet.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Paragraph.bullet.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
Paragraph.bullet.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
Paragraph.bullet.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
Paragraph.bullet.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
Paragraph.bullet.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
Paragraph.bullet.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
Paragraph.bullet.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
Paragraph.bullet.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
Paragraph.bullet.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
Paragraph.bullet.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
Paragraph.bullet.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
Paragraph.bullet.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
Paragraph.bullet.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
Paragraph.bullet.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.endIndex	api_schema_field	End Index	ParagraphElement.endIndex (integer)	The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
ParagraphElement.textRun	api_schema_field	Text Run	ParagraphElement.textRun (object)	A text run paragraph element.
ParagraphElement.textRun.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TextRun.suggestedInsertionIds (array)	The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.textRun.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	TextRun.suggestedTextStyleChanges (object)	The suggested text style changes to this run, keyed by suggestion ID.
ParagraphElement.textRun.textStyle	api_schema_field	Text Style	TextRun.textStyle (object)	The text style of this run.
ParagraphElement.textRun.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.textRun.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.textRun.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.textRun.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.textRun.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.textRun.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.textRun.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.textRun.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.textRun.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.textRun.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.textRun.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.textRun.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.textRun.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.textRun.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.textRun.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.textRun.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.textRun.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.textRun.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.textRun.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.textRun.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.textRun.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.textRun.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.textRun.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.textRun.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TextRun.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.textRun.content	api_schema_field	Content	TextRun.content (string)	The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
ParagraphElement.autoText	api_schema_field	Auto Text	ParagraphElement.autoText (object)	An auto text paragraph element.
ParagraphElement.autoText.type	api_schema_field	Type	AutoText.type (string)	The type of this auto text.
ParagraphElement.autoText.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	AutoText.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.autoText.textStyle	api_schema_field	Text Style	AutoText.textStyle (object)	The text style of this AutoText.
ParagraphElement.autoText.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.autoText.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.autoText.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.autoText.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.autoText.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.autoText.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.autoText.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.autoText.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.autoText.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.autoText.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.autoText.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.autoText.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.autoText.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.autoText.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.autoText.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.autoText.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.autoText.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.autoText.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.autoText.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.autoText.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.autoText.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.autoText.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.autoText.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.autoText.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	AutoText.suggestedInsertionIds (array)	The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.autoText.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	AutoText.suggestedTextStyleChanges (object)	The suggested text style changes to this AutoText, keyed by suggestion ID.
ParagraphElement.inlineObjectElement	api_schema_field	Inline Object Element	ParagraphElement.inlineObjectElement (object)	An inline object paragraph element.
ParagraphElement.inlineObjectElement.textStyle	api_schema_field	Text Style	InlineObjectElement.textStyle (object)	The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
ParagraphElement.inlineObjectElement.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.inlineObjectElement.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.inlineObjectElement.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.inlineObjectElement.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.inlineObjectElement.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.inlineObjectElement.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.inlineObjectElement.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.inlineObjectElement.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.inlineObjectElement.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.inlineObjectElement.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.inlineObjectElement.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.inlineObjectElement.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.inlineObjectElement.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.inlineObjectElement.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.inlineObjectElement.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.inlineObjectElement.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.inlineObjectElement.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.inlineObjectElement.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.inlineObjectElement.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.inlineObjectElement.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.inlineObjectElement.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.inlineObjectElement.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.inlineObjectElement.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.inlineObjectElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	InlineObjectElement.suggestedInsertionIds (array)	The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.inlineObjectElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	InlineObjectElement.suggestedTextStyleChanges (object)	The suggested text style changes to this InlineObject, keyed by suggestion ID.
ParagraphElement.inlineObjectElement.inlineObjectId	api_schema_field	Inline Object Id	InlineObjectElement.inlineObjectId (string)	The ID of the InlineObject this element contains.
ParagraphElement.inlineObjectElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	InlineObjectElement.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.dateElement	api_schema_field	Date Element	ParagraphElement.dateElement (object)	A paragraph element that represents a date.
ParagraphElement.dateElement.suggestedDateElementPropertiesChanges	api_schema_field	Suggested Date Element Properties Changes	DateElement.suggestedDateElementPropertiesChanges (object)	The suggested changes to the date element properties, keyed by suggestion ID.
ParagraphElement.dateElement.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	DateElement.suggestedInsertionIds (array)	IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested…
ParagraphElement.dateElement.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	DateElement.suggestedTextStyleChanges (object)	The suggested text style changes to this DateElement, keyed by suggestion ID.
ParagraphElement.dateElement.textStyle	api_schema_field	Text Style	DateElement.textStyle (object)	The text style of this DateElement.
ParagraphElement.dateElement.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.dateElement.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.dateElement.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.dateElement.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.dateElement.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.dateElement.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.dateElement.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.dateElement.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.dateElement.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.dateElement.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.dateElement.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.dateElement.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.dateElement.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.dateElement.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.dateElement.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.dateElement.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.dateElement.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.dateElement.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.dateElement.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.dateElement.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.dateElement.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.dateElement.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.dateElement.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.dateElement.dateElementProperties	api_schema_field	Date Element Properties	DateElement.dateElementProperties (object)	The properties of this DateElement.
ParagraphElement.dateElement.dateElementProperties.timeFormat	api_schema_field	Time Format	DateElementProperties.timeFormat (string)	Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.
ParagraphElement.dateElement.dateElementProperties.displayText	api_schema_field	Display Text	DateElementProperties.displayText (string)	Output only. Indicates how the DateElement is displayed in the document.
ParagraphElement.dateElement.dateElementProperties.timestamp	api_schema_field	Timestamp	DateElementProperties.timestamp (string)	The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000`…
ParagraphElement.dateElement.dateElementProperties.dateFormat	api_schema_field	Date Format	DateElementProperties.dateFormat (string)	Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent.
ParagraphElement.dateElement.dateElementProperties.timeZoneId	api_schema_field	Time Zone Id	DateElementProperties.timeZoneId (string)	The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`.
ParagraphElement.dateElement.dateElementProperties.locale	api_schema_field	Locale	DateElementProperties.locale (string)	The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`,…
ParagraphElement.dateElement.dateId	api_schema_field	Date Id	DateElement.dateId (string)	Output only. The unique ID of this date.
ParagraphElement.dateElement.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	DateElement.suggestedDeletionIds (array)	IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.
ParagraphElement.pageBreak	api_schema_field	Page Break	ParagraphElement.pageBreak (object)	A page break paragraph element.
ParagraphElement.pageBreak.textStyle	api_schema_field	Text Style	PageBreak.textStyle (object)	The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
ParagraphElement.pageBreak.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.pageBreak.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.pageBreak.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.pageBreak.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.pageBreak.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.pageBreak.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.pageBreak.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.pageBreak.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.pageBreak.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.pageBreak.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.pageBreak.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.pageBreak.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.pageBreak.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.pageBreak.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.pageBreak.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.pageBreak.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.pageBreak.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.pageBreak.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.pageBreak.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.pageBreak.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.pageBreak.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.pageBreak.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.pageBreak.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.pageBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	PageBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.pageBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	PageBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.pageBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	PageBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this PageBreak, keyed by suggestion ID.
ParagraphElement.columnBreak	api_schema_field	Column Break	ParagraphElement.columnBreak (object)	A column break paragraph element.
ParagraphElement.columnBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	ColumnBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.columnBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	ColumnBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.columnBreak.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	ColumnBreak.suggestedTextStyleChanges (object)	The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
ParagraphElement.columnBreak.textStyle	api_schema_field	Text Style	ColumnBreak.textStyle (object)	The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
ParagraphElement.columnBreak.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.columnBreak.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.columnBreak.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.columnBreak.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.columnBreak.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.columnBreak.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.columnBreak.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.columnBreak.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.columnBreak.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.columnBreak.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.columnBreak.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.columnBreak.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.columnBreak.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.columnBreak.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.columnBreak.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.columnBreak.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.columnBreak.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.columnBreak.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.columnBreak.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.columnBreak.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.columnBreak.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.columnBreak.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.columnBreak.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.footnoteReference	api_schema_field	Footnote Reference	ParagraphElement.footnoteReference (object)	A footnote reference paragraph element.
ParagraphElement.footnoteReference.footnoteId	api_schema_field	Footnote Id	FootnoteReference.footnoteId (string)	The ID of the footnote that contains the content of this footnote reference.
ParagraphElement.footnoteReference.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	FootnoteReference.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.footnoteReference.textStyle	api_schema_field	Text Style	FootnoteReference.textStyle (object)	The text style of this FootnoteReference.
ParagraphElement.footnoteReference.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.footnoteReference.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.footnoteReference.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.footnoteReference.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.footnoteReference.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.footnoteReference.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.footnoteReference.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.footnoteReference.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.footnoteReference.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.footnoteReference.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.footnoteReference.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.footnoteReference.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.footnoteReference.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.footnoteReference.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.footnoteReference.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.footnoteReference.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.footnoteReference.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.footnoteReference.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.footnoteReference.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.footnoteReference.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.footnoteReference.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.footnoteReference.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.footnoteReference.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.footnoteReference.footnoteNumber	api_schema_field	Footnote Number	FootnoteReference.footnoteNumber (string)	The rendered number of this footnote.
ParagraphElement.footnoteReference.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	FootnoteReference.suggestedInsertionIds (array)	The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.footnoteReference.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	FootnoteReference.suggestedTextStyleChanges (object)	The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
ParagraphElement.startIndex	api_schema_field	Start Index	ParagraphElement.startIndex (integer)	The zero-based start index of this paragraph element, in UTF-16 code units.
ParagraphElement.richLink	api_schema_field	Rich Link	ParagraphElement.richLink (object)	A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
ParagraphElement.richLink.textStyle	api_schema_field	Text Style	RichLink.textStyle (object)	The text style of this RichLink.
ParagraphElement.richLink.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.richLink.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.richLink.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.richLink.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.richLink.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.richLink.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.richLink.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.richLink.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.richLink.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.richLink.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.richLink.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.richLink.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.richLink.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.richLink.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.richLink.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.richLink.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.richLink.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.richLink.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.richLink.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.richLink.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.richLink.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.richLink.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.richLink.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.richLink.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	RichLink.suggestedInsertionIds (array)	IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a sugge…
ParagraphElement.richLink.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	RichLink.suggestedTextStyleChanges (object)	The suggested text style changes to this RichLink, keyed by suggestion ID.
ParagraphElement.richLink.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	RichLink.suggestedDeletionIds (array)	IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
ParagraphElement.richLink.richLinkId	api_schema_field	Rich Link Id	RichLink.richLinkId (string)	Output only. The ID of this link.
ParagraphElement.richLink.richLinkProperties	api_schema_field	Rich Link Properties	RichLink.richLinkProperties (object)	Output only. The properties of this RichLink. This field is always present.
ParagraphElement.richLink.richLinkProperties.uri	api_schema_field	Uri	RichLinkProperties.uri (string)	The URI to the RichLink. This is always present.
ParagraphElement.richLink.richLinkProperties.title	api_schema_field	Title	RichLinkProperties.title (string)	The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
ParagraphElement.richLink.richLinkProperties.mimeType	api_schema_field	Mime Type	RichLinkProperties.mimeType (string)	The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
ParagraphElement.horizontalRule	api_schema_field	Horizontal Rule	ParagraphElement.horizontalRule (object)	A horizontal rule paragraph element.
ParagraphElement.horizontalRule.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	HorizontalRule.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.horizontalRule.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	HorizontalRule.suggestedInsertionIds (array)	The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
ParagraphElement.horizontalRule.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	HorizontalRule.suggestedTextStyleChanges (object)	The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
ParagraphElement.horizontalRule.textStyle	api_schema_field	Text Style	HorizontalRule.textStyle (object)	The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
ParagraphElement.horizontalRule.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.horizontalRule.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.horizontalRule.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.horizontalRule.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.horizontalRule.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.horizontalRule.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.horizontalRule.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.horizontalRule.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.horizontalRule.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.horizontalRule.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.horizontalRule.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.horizontalRule.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.horizontalRule.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.horizontalRule.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.horizontalRule.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.horizontalRule.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.horizontalRule.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.horizontalRule.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.horizontalRule.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.horizontalRule.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.horizontalRule.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.horizontalRule.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.horizontalRule.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.person	api_schema_field	Person	ParagraphElement.person (object)	A paragraph element that links to a person or email address.
ParagraphElement.person.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Person.suggestedDeletionIds (array)	IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
ParagraphElement.person.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Person.suggestedInsertionIds (array)	IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a…
ParagraphElement.person.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	Person.suggestedTextStyleChanges (object)	The suggested text style changes to this Person, keyed by suggestion ID.
ParagraphElement.person.personId	api_schema_field	Person Id	Person.personId (string)	Output only. The unique ID of this link.
ParagraphElement.person.personProperties	api_schema_field	Person Properties	Person.personProperties (object)	Output only. The properties of this Person. This field is always present.
ParagraphElement.person.personProperties.name	schema_pii_or_identity_field	Name	PersonProperties.name (string)	The name of the person if it's displayed in the link text instead of the person's email address.
ParagraphElement.person.personProperties.email	schema_pii_or_identity_field	Email	PersonProperties.email (string)	The email address linked to this Person. This field is always present.
ParagraphElement.person.textStyle	api_schema_field	Text Style	Person.textStyle (object)	The text style of this Person.
ParagraphElement.person.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.person.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.person.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
ParagraphElement.person.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
ParagraphElement.person.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
ParagraphElement.person.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
ParagraphElement.person.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
ParagraphElement.person.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
ParagraphElement.person.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
ParagraphElement.person.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
ParagraphElement.person.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
ParagraphElement.person.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
ParagraphElement.person.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
ParagraphElement.person.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
ParagraphElement.person.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
ParagraphElement.person.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
ParagraphElement.person.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
ParagraphElement.person.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.person.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
ParagraphElement.person.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
ParagraphElement.person.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
ParagraphElement.person.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
ParagraphElement.person.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
ParagraphElement.equation	api_schema_field	Equation	ParagraphElement.equation (object)	An equation paragraph element.
ParagraphElement.equation.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Equation.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
ParagraphElement.equation.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Equation.suggestedInsertionIds (array)	The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TextRun.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TextRun.suggestedInsertionIds (array)	The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TextRun.suggestedTextStyleChanges	api_schema_field	Suggested Text Style Changes	TextRun.suggestedTextStyleChanges (object)	The suggested text style changes to this run, keyed by suggestion ID.
TextRun.textStyle	api_schema_field	Text Style	TextRun.textStyle (object)	The text style of this run.
TextRun.textStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
TextRun.textStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TextRun.textStyle.foregroundColor.color.rgbColor	api_schema_field	Rgb Color	Color.rgbColor (object)	The RGB color value.
TextRun.textStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
TextRun.textStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
TextRun.textStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
TextRun.textStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TextRun.textStyle.backgroundColor.color.rgbColor	api_schema_field	Rgb Color	Color.rgbColor (object)	The RGB color value.
TextRun.textStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
TextRun.textStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TextRun.textStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TextRun.textStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
TextRun.textStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
TextRun.textStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
TextRun.textStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
TextRun.textStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
TextRun.textStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
TextRun.textStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
TextRun.textStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
TextRun.textStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
TextRun.textStyle.link.heading.tabId	api_schema_field	Tab Id	HeadingLink.tabId (string)	The ID of the tab containing this heading.
TextRun.textStyle.link.heading.id	api_schema_field	Id	HeadingLink.id (string)	The ID of a heading in this document.
TextRun.textStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
TextRun.textStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
TextRun.textStyle.link.bookmark.id	api_schema_field	Id	BookmarkLink.id (string)	The ID of a bookmark in this document.
TextRun.textStyle.link.bookmark.tabId	api_schema_field	Tab Id	BookmarkLink.tabId (string)	The ID of the tab containing this bookmark.
TextRun.textStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
TextRun.textStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
TextRun.textStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
TextRun.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TextRun.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TextRun.content	api_schema_field	Content	TextRun.content (string)	The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
TextStyle.foregroundColor	api_schema_field	Foreground Color	TextStyle.foregroundColor (object)	The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
TextStyle.foregroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TextStyle.foregroundColor.color.rgbColor	api_schema_field	Rgb Color	Color.rgbColor (object)	The RGB color value.
TextStyle.foregroundColor.color.rgbColor.red	api_schema_field	Red	RgbColor.red (number)	The red component of the color, from 0.0 to 1.0.
TextStyle.foregroundColor.color.rgbColor.blue	api_schema_field	Blue	RgbColor.blue (number)	The blue component of the color, from 0.0 to 1.0.
TextStyle.foregroundColor.color.rgbColor.green	api_schema_field	Green	RgbColor.green (number)	The green component of the color, from 0.0 to 1.0.
TextStyle.baselineOffset	api_schema_field	Baseline Offset	TextStyle.baselineOffset (string)	The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
TextStyle.underline	api_schema_field	Underline	TextStyle.underline (boolean)	Whether or not the text is underlined.
TextStyle.backgroundColor	api_schema_field	Background Color	TextStyle.backgroundColor (object)	The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
TextStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TextStyle.backgroundColor.color.rgbColor	api_schema_field	Rgb Color	Color.rgbColor (object)	The RGB color value.
TextStyle.backgroundColor.color.rgbColor.red	api_schema_field	Red	RgbColor.red (number)	The red component of the color, from 0.0 to 1.0.
TextStyle.backgroundColor.color.rgbColor.blue	api_schema_field	Blue	RgbColor.blue (number)	The blue component of the color, from 0.0 to 1.0.
TextStyle.backgroundColor.color.rgbColor.green	api_schema_field	Green	RgbColor.green (number)	The green component of the color, from 0.0 to 1.0.
TextStyle.fontSize	api_schema_field	Font Size	TextStyle.fontSize (object)	The size of the text's font.
TextStyle.fontSize.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TextStyle.fontSize.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TextStyle.weightedFontFamily	api_schema_field	Weighted Font Family	TextStyle.weightedFontFamily (object)	The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If…
TextStyle.weightedFontFamily.fontFamily	api_schema_field	Font Family	WeightedFontFamily.fontFamily (string)	The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
TextStyle.weightedFontFamily.weight	api_schema_field	Weight	WeightedFontFamily.weight (integer)	The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#f…
TextStyle.strikethrough	api_schema_field	Strikethrough	TextStyle.strikethrough (boolean)	Whether or not the text is struck through.
TextStyle.link	api_schema_field	Link	TextStyle.link (object)	The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will…
TextStyle.link.bookmarkId	api_schema_field	Bookmark Id	Link.bookmarkId (string)	The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and…
TextStyle.link.url	api_schema_field	Url	Link.url (string)	An external URL.
TextStyle.link.tabId	api_schema_field	Tab Id	Link.tabId (string)	The ID of a tab in this document.
TextStyle.link.heading	api_schema_field	Heading	Link.heading (object)	A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
TextStyle.link.heading.tabId	api_schema_field	Tab Id	HeadingLink.tabId (string)	The ID of the tab containing this heading.
TextStyle.link.heading.id	api_schema_field	Id	HeadingLink.id (string)	The ID of a heading in this document.
TextStyle.link.headingId	api_schema_field	Heading Id	Link.headingId (string)	The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and li…
TextStyle.link.bookmark	api_schema_field	Bookmark	Link.bookmark (object)	A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
TextStyle.link.bookmark.id	api_schema_field	Id	BookmarkLink.id (string)	The ID of a bookmark in this document.
TextStyle.link.bookmark.tabId	api_schema_field	Tab Id	BookmarkLink.tabId (string)	The ID of the tab containing this bookmark.
TextStyle.italic	api_schema_field	Italic	TextStyle.italic (boolean)	Whether or not the text is italicized.
TextStyle.smallCaps	api_schema_field	Small Caps	TextStyle.smallCaps (boolean)	Whether or not the text is in small capital letters.
TextStyle.bold	api_schema_field	Bold	TextStyle.bold (boolean)	Whether or not the text is rendered as bold.
Table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
Table.tableRows.startIndex	api_schema_field	Start Index	TableRow.startIndex (integer)	The zero-based start index of this row, in UTF-16 code units.
Table.tableRows.tableCells	api_schema_field	Table Cells	TableRow.tableCells (array)	The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
Table.tableRows.tableCells.content	api_schema_field	Content	TableCell.content (array)	The content of the cell.
Table.tableRows.tableCells.content.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
Table.tableRows.tableCells.content.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
Table.tableRows.tableCells.content.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
Table.tableRows.tableCells.content.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
Table.tableRows.tableCells.content.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
Table.tableRows.tableCells.content.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
Table.tableRows.tableCells.startIndex	api_schema_field	Start Index	TableCell.startIndex (integer)	The zero-based start index of this cell, in UTF-16 code units.
Table.tableRows.tableCells.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableCell.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Table.tableRows.tableCells.suggestedTableCellStyleChanges	api_schema_field	Suggested Table Cell Style Changes	TableCell.suggestedTableCellStyleChanges (object)	The suggested changes to the table cell style, keyed by suggestion ID.
Table.tableRows.tableCells.endIndex	api_schema_field	End Index	TableCell.endIndex (integer)	The zero-based end index of this cell, exclusive, in UTF-16 code units.
Table.tableRows.tableCells.tableCellStyle	api_schema_field	Table Cell Style	TableCell.tableCellStyle (object)	The style of the cell.
Table.tableRows.tableCells.tableCellStyle.paddingBottom	api_schema_field	Padding Bottom	TableCellStyle.paddingBottom (object)	The bottom padding of the cell.
Table.tableRows.tableCells.tableCellStyle.paddingRight	api_schema_field	Padding Right	TableCellStyle.paddingRight (object)	The right padding of the cell.
Table.tableRows.tableCells.tableCellStyle.contentAlignment	api_schema_field	Content Alignment	TableCellStyle.contentAlignment (string)	The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
Table.tableRows.tableCells.tableCellStyle.paddingLeft	api_schema_field	Padding Left	TableCellStyle.paddingLeft (object)	The left padding of the cell.
Table.tableRows.tableCells.tableCellStyle.columnSpan	api_schema_field	Column Span	TableCellStyle.columnSpan (integer)	The column span of the cell. This property is read-only.
Table.tableRows.tableCells.tableCellStyle.backgroundColor	api_schema_field	Background Color	TableCellStyle.backgroundColor (object)	The background color of the cell.
Table.tableRows.tableCells.tableCellStyle.paddingTop	api_schema_field	Padding Top	TableCellStyle.paddingTop (object)	The top padding of the cell.
Table.tableRows.tableCells.tableCellStyle.borderLeft	api_schema_field	Border Left	TableCellStyle.borderLeft (object)	The left border of the cell.
Table.tableRows.tableCells.tableCellStyle.borderRight	api_schema_field	Border Right	TableCellStyle.borderRight (object)	The right border of the cell.
Table.tableRows.tableCells.tableCellStyle.borderTop	api_schema_field	Border Top	TableCellStyle.borderTop (object)	The top border of the cell.
Table.tableRows.tableCells.tableCellStyle.borderBottom	api_schema_field	Border Bottom	TableCellStyle.borderBottom (object)	The bottom border of the cell.
Table.tableRows.tableCells.tableCellStyle.rowSpan	api_schema_field	Row Span	TableCellStyle.rowSpan (integer)	The row span of the cell. This property is read-only.
Table.tableRows.tableCells.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableCell.suggestedInsertionIds (array)	The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Table.tableRows.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableRow.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Table.tableRows.endIndex	api_schema_field	End Index	TableRow.endIndex (integer)	The zero-based end index of this row, exclusive, in UTF-16 code units.
Table.tableRows.tableRowStyle	api_schema_field	Table Row Style	TableRow.tableRowStyle (object)	The style of the table row.
Table.tableRows.tableRowStyle.minRowHeight	api_schema_field	Min Row Height	TableRowStyle.minRowHeight (object)	The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
Table.tableRows.tableRowStyle.minRowHeight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Table.tableRows.tableRowStyle.minRowHeight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Table.tableRows.tableRowStyle.preventOverflow	api_schema_field	Prevent Overflow	TableRowStyle.preventOverflow (boolean)	Whether the row cannot overflow across page or column boundaries.
Table.tableRows.tableRowStyle.tableHeader	api_schema_field	Table Header	TableRowStyle.tableHeader (boolean)	Whether the row is a table header.
Table.tableRows.suggestedTableRowStyleChanges	api_schema_field	Suggested Table Row Style Changes	TableRow.suggestedTableRowStyleChanges (object)	The suggested style changes to this row, keyed by suggestion ID.
Table.tableRows.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableRow.suggestedInsertionIds (array)	The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
Table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
Table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
Table.tableStyle.tableColumnProperties	api_schema_field	Table Column Properties	TableStyle.tableColumnProperties (array)	The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
Table.tableStyle.tableColumnProperties.widthType	api_schema_field	Width Type	TableColumnProperties.widthType (string)	The width type of the column.
Table.tableStyle.tableColumnProperties.width	api_schema_field	Width	TableColumnProperties.width (object)	The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
Table.tableStyle.tableColumnProperties.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
Table.tableStyle.tableColumnProperties.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
Table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
Table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
TableRow.startIndex	api_schema_field	Start Index	TableRow.startIndex (integer)	The zero-based start index of this row, in UTF-16 code units.
TableRow.tableCells	api_schema_field	Table Cells	TableRow.tableCells (array)	The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
TableRow.tableCells.content	api_schema_field	Content	TableCell.content (array)	The content of the cell.
TableRow.tableCells.content.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
TableRow.tableCells.content.sectionBreak.sectionStyle	api_schema_field	Section Style	SectionBreak.sectionStyle (object)	The style of the section after this section break.
TableRow.tableCells.content.sectionBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	SectionBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableRow.tableCells.content.sectionBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	SectionBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableRow.tableCells.content.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
TableRow.tableCells.content.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
TableRow.tableCells.content.tableOfContents.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableOfContents.suggestedInsertionIds (array)	The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
TableRow.tableCells.content.tableOfContents.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableOfContents.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableRow.tableCells.content.tableOfContents.content	api_schema_field	Content	TableOfContents.content (array)	The content of the table of contents.
TableRow.tableCells.content.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
TableRow.tableCells.content.table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
TableRow.tableCells.content.table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableRow.tableCells.content.table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
TableRow.tableCells.content.table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
TableRow.tableCells.content.table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableRow.tableCells.content.table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
TableRow.tableCells.content.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
TableRow.tableCells.content.paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
TableRow.tableCells.content.paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
TableRow.tableCells.content.paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
TableRow.tableCells.content.paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
TableRow.tableCells.content.paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
TableRow.tableCells.content.paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
TableRow.tableCells.content.paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
TableRow.tableCells.content.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
TableRow.tableCells.startIndex	api_schema_field	Start Index	TableCell.startIndex (integer)	The zero-based start index of this cell, in UTF-16 code units.
TableRow.tableCells.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableCell.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableRow.tableCells.suggestedTableCellStyleChanges	api_schema_field	Suggested Table Cell Style Changes	TableCell.suggestedTableCellStyleChanges (object)	The suggested changes to the table cell style, keyed by suggestion ID.
TableRow.tableCells.endIndex	api_schema_field	End Index	TableCell.endIndex (integer)	The zero-based end index of this cell, exclusive, in UTF-16 code units.
TableRow.tableCells.tableCellStyle	api_schema_field	Table Cell Style	TableCell.tableCellStyle (object)	The style of the cell.
TableRow.tableCells.tableCellStyle.paddingBottom	api_schema_field	Padding Bottom	TableCellStyle.paddingBottom (object)	The bottom padding of the cell.
TableRow.tableCells.tableCellStyle.paddingBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableRow.tableCells.tableCellStyle.paddingBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableRow.tableCells.tableCellStyle.paddingRight	api_schema_field	Padding Right	TableCellStyle.paddingRight (object)	The right padding of the cell.
TableRow.tableCells.tableCellStyle.paddingRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableRow.tableCells.tableCellStyle.paddingRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableRow.tableCells.tableCellStyle.contentAlignment	api_schema_field	Content Alignment	TableCellStyle.contentAlignment (string)	The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
TableRow.tableCells.tableCellStyle.paddingLeft	api_schema_field	Padding Left	TableCellStyle.paddingLeft (object)	The left padding of the cell.
TableRow.tableCells.tableCellStyle.paddingLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableRow.tableCells.tableCellStyle.paddingLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableRow.tableCells.tableCellStyle.columnSpan	api_schema_field	Column Span	TableCellStyle.columnSpan (integer)	The column span of the cell. This property is read-only.
TableRow.tableCells.tableCellStyle.backgroundColor	api_schema_field	Background Color	TableCellStyle.backgroundColor (object)	The background color of the cell.
TableRow.tableCells.tableCellStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableRow.tableCells.tableCellStyle.paddingTop	api_schema_field	Padding Top	TableCellStyle.paddingTop (object)	The top padding of the cell.
TableRow.tableCells.tableCellStyle.paddingTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableRow.tableCells.tableCellStyle.paddingTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableRow.tableCells.tableCellStyle.borderLeft	api_schema_field	Border Left	TableCellStyle.borderLeft (object)	The left border of the cell.
TableRow.tableCells.tableCellStyle.borderLeft.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableRow.tableCells.tableCellStyle.borderLeft.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableRow.tableCells.tableCellStyle.borderLeft.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableRow.tableCells.tableCellStyle.borderRight	api_schema_field	Border Right	TableCellStyle.borderRight (object)	The right border of the cell.
TableRow.tableCells.tableCellStyle.borderRight.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableRow.tableCells.tableCellStyle.borderRight.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableRow.tableCells.tableCellStyle.borderRight.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableRow.tableCells.tableCellStyle.borderTop	api_schema_field	Border Top	TableCellStyle.borderTop (object)	The top border of the cell.
TableRow.tableCells.tableCellStyle.borderTop.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableRow.tableCells.tableCellStyle.borderTop.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableRow.tableCells.tableCellStyle.borderTop.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableRow.tableCells.tableCellStyle.borderBottom	api_schema_field	Border Bottom	TableCellStyle.borderBottom (object)	The bottom border of the cell.
TableRow.tableCells.tableCellStyle.borderBottom.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableRow.tableCells.tableCellStyle.borderBottom.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableRow.tableCells.tableCellStyle.borderBottom.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableRow.tableCells.tableCellStyle.rowSpan	api_schema_field	Row Span	TableCellStyle.rowSpan (integer)	The row span of the cell. This property is read-only.
TableRow.tableCells.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableCell.suggestedInsertionIds (array)	The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableRow.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableRow.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableRow.endIndex	api_schema_field	End Index	TableRow.endIndex (integer)	The zero-based end index of this row, exclusive, in UTF-16 code units.
TableRow.tableRowStyle	api_schema_field	Table Row Style	TableRow.tableRowStyle (object)	The style of the table row.
TableRow.tableRowStyle.minRowHeight	api_schema_field	Min Row Height	TableRowStyle.minRowHeight (object)	The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
TableRow.tableRowStyle.minRowHeight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableRow.tableRowStyle.minRowHeight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableRow.tableRowStyle.preventOverflow	api_schema_field	Prevent Overflow	TableRowStyle.preventOverflow (boolean)	Whether the row cannot overflow across page or column boundaries.
TableRow.tableRowStyle.tableHeader	api_schema_field	Table Header	TableRowStyle.tableHeader (boolean)	Whether the row is a table header.
TableRow.suggestedTableRowStyleChanges	api_schema_field	Suggested Table Row Style Changes	TableRow.suggestedTableRowStyleChanges (object)	The suggested style changes to this row, keyed by suggestion ID.
TableRow.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableRow.suggestedInsertionIds (array)	The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableCell.content	api_schema_field	Content	TableCell.content (array)	The content of the cell.
TableCell.content.sectionBreak	api_schema_field	Section Break	StructuralElement.sectionBreak (object)	A section break type of structural element.
TableCell.content.sectionBreak.sectionStyle	api_schema_field	Section Style	SectionBreak.sectionStyle (object)	The style of the section after this section break.
TableCell.content.sectionBreak.sectionStyle.marginTop	api_schema_field	Margin Top	SectionStyle.marginTop (object)	The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property resu…
TableCell.content.sectionBreak.sectionStyle.marginBottom	api_schema_field	Margin Bottom	SectionStyle.marginBottom (object)	The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this propert…
TableCell.content.sectionBreak.sectionStyle.pageNumberStart	api_schema_field	Page Number Start	SectionStyle.pageNumberStart (integer)	The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PA…
TableCell.content.sectionBreak.sectionStyle.defaultHeaderId	api_schema_field	Default Header Id	SectionStyle.defaultHeaderId (string)	The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not…
TableCell.content.sectionBreak.sectionStyle.evenPageHeaderId	api_schema_field	Even Page Header Id	SectionStyle.evenPageHeaderId (string)	The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset,…
TableCell.content.sectionBreak.sectionStyle.firstPageHeaderId	api_schema_field	First Page Header Id	SectionStyle.firstPageHeaderId (string)	The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_i…
TableCell.content.sectionBreak.sectionStyle.marginLeft	api_schema_field	Margin Left	SectionStyle.marginLeft (object)	The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMo…
TableCell.content.sectionBreak.sectionStyle.evenPageFooterId	api_schema_field	Even Page Footer Id	SectionStyle.evenPageFooterId (string)	The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset,…
TableCell.content.sectionBreak.sectionStyle.marginRight	api_schema_field	Margin Right	SectionStyle.marginRight (object)	The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If Documen…
TableCell.content.sectionBreak.sectionStyle.marginHeader	api_schema_field	Margin Header	SectionStyle.marginHeader (object)	The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a hea…
TableCell.content.sectionBreak.sectionStyle.useFirstPageHeaderFooter	api_schema_field	Use First Page Header Footer	SectionStyle.useFirstPageHeaderFooter (boolean)	Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interprete…
TableCell.content.sectionBreak.sectionStyle.marginFooter	api_schema_field	Margin Footer	SectionStyle.marginFooter (object)	The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a foo…
TableCell.content.sectionBreak.sectionStyle.columnSeparatorStyle	api_schema_field	Column Separator Style	SectionStyle.columnSeparatorStyle (string)	The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
TableCell.content.sectionBreak.sectionStyle.contentDirection	api_schema_field	Content Direction	SectionStyle.contentDirection (string)	The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
TableCell.content.sectionBreak.sectionStyle.sectionType	api_schema_field	Section Type	SectionStyle.sectionType (string)	Output only. The type of section.
TableCell.content.sectionBreak.sectionStyle.columnProperties	api_schema_field	Column Properties	SectionStyle.columnProperties (array)	The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting t…
TableCell.content.sectionBreak.sectionStyle.flipPageOrientation	api_schema_field	Flip Page Orientation	SectionStyle.flipPageOrientation (boolean)	Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMo…
TableCell.content.sectionBreak.sectionStyle.defaultFooterId	api_schema_field	Default Footer Id	SectionStyle.defaultFooterId (string)	The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not…
TableCell.content.sectionBreak.sectionStyle.firstPageFooterId	api_schema_field	First Page Footer Id	SectionStyle.firstPageFooterId (string)	The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_i…
TableCell.content.sectionBreak.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	SectionBreak.suggestedInsertionIds (array)	The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableCell.content.sectionBreak.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	SectionBreak.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableCell.content.startIndex	api_schema_field	Start Index	StructuralElement.startIndex (integer)	The zero-based start index of this structural element, in UTF-16 code units.
TableCell.content.tableOfContents	api_schema_field	Table Of Contents	StructuralElement.tableOfContents (object)	A table of contents type of structural element.
TableCell.content.tableOfContents.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableOfContents.suggestedInsertionIds (array)	The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
TableCell.content.tableOfContents.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableOfContents.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableCell.content.tableOfContents.content	api_schema_field	Content	TableOfContents.content (array)	The content of the table of contents.
TableCell.content.table	api_schema_field	Table	StructuralElement.table (object)	A table type of structural element.
TableCell.content.table.tableRows	api_schema_field	Table Rows	Table.tableRows (array)	The contents and style of each row.
TableCell.content.table.tableRows.startIndex	api_schema_field	Start Index	TableRow.startIndex (integer)	The zero-based start index of this row, in UTF-16 code units.
TableCell.content.table.tableRows.tableCells	api_schema_field	Table Cells	TableRow.tableCells (array)	The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
TableCell.content.table.tableRows.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableRow.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableCell.content.table.tableRows.endIndex	api_schema_field	End Index	TableRow.endIndex (integer)	The zero-based end index of this row, exclusive, in UTF-16 code units.
TableCell.content.table.tableRows.tableRowStyle	api_schema_field	Table Row Style	TableRow.tableRowStyle (object)	The style of the table row.
TableCell.content.table.tableRows.suggestedTableRowStyleChanges	api_schema_field	Suggested Table Row Style Changes	TableRow.suggestedTableRowStyleChanges (object)	The suggested style changes to this row, keyed by suggestion ID.
TableCell.content.table.tableRows.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableRow.suggestedInsertionIds (array)	The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableCell.content.table.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	Table.suggestedInsertionIds (array)	The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
TableCell.content.table.columns	api_schema_field	Columns	Table.columns (integer)	Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
TableCell.content.table.tableStyle	api_schema_field	Table Style	Table.tableStyle (object)	The style of the table.
TableCell.content.table.tableStyle.tableColumnProperties	api_schema_field	Table Column Properties	TableStyle.tableColumnProperties (array)	The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
TableCell.content.table.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	Table.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableCell.content.table.rows	api_schema_field	Rows	Table.rows (integer)	Number of rows in the table.
TableCell.content.paragraph	api_schema_field	Paragraph	StructuralElement.paragraph (object)	A paragraph type of structural element.
TableCell.content.paragraph.suggestedParagraphStyleChanges	api_schema_field	Suggested Paragraph Style Changes	Paragraph.suggestedParagraphStyleChanges (object)	The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
TableCell.content.paragraph.paragraphStyle	api_schema_field	Paragraph Style	Paragraph.paragraphStyle (object)	The style of this paragraph.
TableCell.content.paragraph.paragraphStyle.borderTop	api_schema_field	Border Top	ParagraphStyle.borderTop (object)	The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph…
TableCell.content.paragraph.paragraphStyle.borderRight	api_schema_field	Border Right	ParagraphStyle.borderRight (object)	The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
TableCell.content.paragraph.paragraphStyle.shading	api_schema_field	Shading	ParagraphStyle.shading (object)	The shading of the paragraph. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.headingId	api_schema_field	Heading Id	ParagraphStyle.headingId (string)	The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
TableCell.content.paragraph.paragraphStyle.indentFirstLine	api_schema_field	Indent First Line	ParagraphStyle.indentFirstLine (object)	The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.borderBetween	api_schema_field	Border Between	ParagraphStyle.borderBetween (object)	The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partial…
TableCell.content.paragraph.paragraphStyle.spaceAbove	api_schema_field	Space Above	ParagraphStyle.spaceAbove (object)	The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.indentStart	api_schema_field	Indent Start	ParagraphStyle.indentStart (object)	The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.tabStops	api_schema_field	Tab Stops	ParagraphStyle.tabStops (array)	A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
TableCell.content.paragraph.paragraphStyle.namedStyleType	schema_pii_or_identity_field	Named Style Type	ParagraphStyle.namedStyleType (string)	The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
TableCell.content.paragraph.paragraphStyle.alignment	api_schema_field	Alignment	ParagraphStyle.alignment (string)	The text alignment for this paragraph.
TableCell.content.paragraph.paragraphStyle.borderLeft	api_schema_field	Border Left	ParagraphStyle.borderLeft (object)	The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
TableCell.content.paragraph.paragraphStyle.indentEnd	api_schema_field	Indent End	ParagraphStyle.indentEnd (object)	The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.pageBreakBefore	api_schema_field	Page Break Before	ParagraphStyle.pageBreakBefore (boolean)	Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can res…
TableCell.content.paragraph.paragraphStyle.borderBottom	api_schema_field	Border Bottom	ParagraphStyle.borderBottom (object)	The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a par…
TableCell.content.paragraph.paragraphStyle.direction	api_schema_field	Direction	ParagraphStyle.direction (string)	The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
TableCell.content.paragraph.paragraphStyle.keepWithNext	api_schema_field	Keep With Next	ParagraphStyle.keepWithNext (boolean)	Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.keepLinesTogether	api_schema_field	Keep Lines Together	ParagraphStyle.keepLinesTogether (boolean)	Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.spacingMode	api_schema_field	Spacing Mode	ParagraphStyle.spacingMode (string)	The spacing mode for the paragraph.
TableCell.content.paragraph.paragraphStyle.lineSpacing	api_schema_field	Line Spacing	ParagraphStyle.lineSpacing (number)	The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.avoidWidowAndOrphan	api_schema_field	Avoid Widow And Orphan	ParagraphStyle.avoidWidowAndOrphan (boolean)	Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
TableCell.content.paragraph.paragraphStyle.spaceBelow	api_schema_field	Space Below	ParagraphStyle.spaceBelow (object)	The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
TableCell.content.paragraph.suggestedBulletChanges	api_schema_field	Suggested Bullet Changes	Paragraph.suggestedBulletChanges (object)	The suggested changes to this paragraph's bullet.
TableCell.content.paragraph.suggestedPositionedObjectIds	api_schema_field	Suggested Positioned Object Ids	Paragraph.suggestedPositionedObjectIds (object)	The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
TableCell.content.paragraph.positionedObjectIds	api_schema_field	Positioned Object Ids	Paragraph.positionedObjectIds (array)	The IDs of the positioned objects tethered to this paragraph.
TableCell.content.paragraph.elements	api_schema_field	Elements	Paragraph.elements (array)	The content of the paragraph, broken down into its component parts.
TableCell.content.paragraph.elements.endIndex	api_schema_field	End Index	ParagraphElement.endIndex (integer)	The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
TableCell.content.paragraph.elements.textRun	api_schema_field	Text Run	ParagraphElement.textRun (object)	A text run paragraph element.
TableCell.content.paragraph.elements.autoText	api_schema_field	Auto Text	ParagraphElement.autoText (object)	An auto text paragraph element.
TableCell.content.paragraph.elements.inlineObjectElement	api_schema_field	Inline Object Element	ParagraphElement.inlineObjectElement (object)	An inline object paragraph element.
TableCell.content.paragraph.elements.dateElement	api_schema_field	Date Element	ParagraphElement.dateElement (object)	A paragraph element that represents a date.
TableCell.content.paragraph.elements.pageBreak	api_schema_field	Page Break	ParagraphElement.pageBreak (object)	A page break paragraph element.
TableCell.content.paragraph.elements.columnBreak	api_schema_field	Column Break	ParagraphElement.columnBreak (object)	A column break paragraph element.
TableCell.content.paragraph.elements.footnoteReference	api_schema_field	Footnote Reference	ParagraphElement.footnoteReference (object)	A footnote reference paragraph element.
TableCell.content.paragraph.elements.startIndex	api_schema_field	Start Index	ParagraphElement.startIndex (integer)	The zero-based start index of this paragraph element, in UTF-16 code units.
TableCell.content.paragraph.elements.richLink	api_schema_field	Rich Link	ParagraphElement.richLink (object)	A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
TableCell.content.paragraph.elements.horizontalRule	api_schema_field	Horizontal Rule	ParagraphElement.horizontalRule (object)	A horizontal rule paragraph element.
TableCell.content.paragraph.elements.person	api_schema_field	Person	ParagraphElement.person (object)	A paragraph element that links to a person or email address.
TableCell.content.paragraph.elements.equation	api_schema_field	Equation	ParagraphElement.equation (object)	An equation paragraph element.
TableCell.content.paragraph.bullet	api_schema_field	Bullet	Paragraph.bullet (object)	The bullet for this paragraph. If not present, the paragraph does not belong to a list.
TableCell.content.paragraph.bullet.listId	api_schema_field	List Id	Bullet.listId (string)	The ID of the list this paragraph belongs to.
TableCell.content.paragraph.bullet.nestingLevel	api_schema_field	Nesting Level	Bullet.nestingLevel (integer)	The nesting level of this paragraph in the list.
TableCell.content.paragraph.bullet.textStyle	api_schema_field	Text Style	Bullet.textStyle (object)	The paragraph-specific text style applied to this bullet.
TableCell.content.endIndex	api_schema_field	End Index	StructuralElement.endIndex (integer)	The zero-based end index of this structural element, exclusive, in UTF-16 code units.
TableCell.startIndex	api_schema_field	Start Index	TableCell.startIndex (integer)	The zero-based start index of this cell, in UTF-16 code units.
TableCell.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	TableCell.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
TableCell.suggestedTableCellStyleChanges	api_schema_field	Suggested Table Cell Style Changes	TableCell.suggestedTableCellStyleChanges (object)	The suggested changes to the table cell style, keyed by suggestion ID.
TableCell.endIndex	api_schema_field	End Index	TableCell.endIndex (integer)	The zero-based end index of this cell, exclusive, in UTF-16 code units.
TableCell.tableCellStyle	api_schema_field	Table Cell Style	TableCell.tableCellStyle (object)	The style of the cell.
TableCell.tableCellStyle.paddingBottom	api_schema_field	Padding Bottom	TableCellStyle.paddingBottom (object)	The bottom padding of the cell.
TableCell.tableCellStyle.paddingBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.paddingBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.paddingRight	api_schema_field	Padding Right	TableCellStyle.paddingRight (object)	The right padding of the cell.
TableCell.tableCellStyle.paddingRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.paddingRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.contentAlignment	api_schema_field	Content Alignment	TableCellStyle.contentAlignment (string)	The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
TableCell.tableCellStyle.paddingLeft	api_schema_field	Padding Left	TableCellStyle.paddingLeft (object)	The left padding of the cell.
TableCell.tableCellStyle.paddingLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.paddingLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.columnSpan	api_schema_field	Column Span	TableCellStyle.columnSpan (integer)	The column span of the cell. This property is read-only.
TableCell.tableCellStyle.backgroundColor	api_schema_field	Background Color	TableCellStyle.backgroundColor (object)	The background color of the cell.
TableCell.tableCellStyle.backgroundColor.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableCell.tableCellStyle.backgroundColor.color.rgbColor	api_schema_field	Rgb Color	Color.rgbColor (object)	The RGB color value.
TableCell.tableCellStyle.paddingTop	api_schema_field	Padding Top	TableCellStyle.paddingTop (object)	The top padding of the cell.
TableCell.tableCellStyle.paddingTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.paddingTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.borderLeft	api_schema_field	Border Left	TableCellStyle.borderLeft (object)	The left border of the cell.
TableCell.tableCellStyle.borderLeft.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableCell.tableCellStyle.borderLeft.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableCell.tableCellStyle.borderLeft.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableCell.tableCellStyle.borderLeft.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableCell.tableCellStyle.borderLeft.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.borderLeft.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.borderRight	api_schema_field	Border Right	TableCellStyle.borderRight (object)	The right border of the cell.
TableCell.tableCellStyle.borderRight.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableCell.tableCellStyle.borderRight.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableCell.tableCellStyle.borderRight.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableCell.tableCellStyle.borderRight.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableCell.tableCellStyle.borderRight.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.borderRight.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.borderTop	api_schema_field	Border Top	TableCellStyle.borderTop (object)	The top border of the cell.
TableCell.tableCellStyle.borderTop.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableCell.tableCellStyle.borderTop.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableCell.tableCellStyle.borderTop.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableCell.tableCellStyle.borderTop.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableCell.tableCellStyle.borderTop.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.borderTop.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.borderBottom	api_schema_field	Border Bottom	TableCellStyle.borderBottom (object)	The bottom border of the cell.
TableCell.tableCellStyle.borderBottom.color	api_schema_field	Color	TableCellBorder.color (object)	The color of the border. This color cannot be transparent.
TableCell.tableCellStyle.borderBottom.color.color	api_schema_field	Color	OptionalColor.color (object)	If set, this will be used as an opaque color. If unset, this represents a transparent color.
TableCell.tableCellStyle.borderBottom.dashStyle	api_schema_field	Dash Style	TableCellBorder.dashStyle (string)	The dash style of the border.
TableCell.tableCellStyle.borderBottom.width	api_schema_field	Width	TableCellBorder.width (object)	The width of the border.
TableCell.tableCellStyle.borderBottom.width.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
TableCell.tableCellStyle.borderBottom.width.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
TableCell.tableCellStyle.rowSpan	api_schema_field	Row Span	TableCellStyle.rowSpan (integer)	The row span of the cell. This property is read-only.
TableCell.suggestedInsertionIds	api_schema_field	Suggested Insertion Ids	TableCell.suggestedInsertionIds (array)	The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
InlineObject.objectId	api_schema_field	Object Id	InlineObject.objectId (string)	The ID of this inline object. Can be used to update an object’s properties.
InlineObject.suggestedInlineObjectPropertiesChanges	api_schema_field	Suggested Inline Object Properties Changes	InlineObject.suggestedInlineObjectPropertiesChanges (object)	The suggested changes to the inline object properties, keyed by suggestion ID.
InlineObject.suggestedInsertionId	api_schema_field	Suggested Insertion Id	InlineObject.suggestedInsertionId (string)	The suggested insertion ID. If empty, then this is not a suggested insertion.
InlineObject.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	InlineObject.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
InlineObject.inlineObjectProperties	api_schema_field	Inline Object Properties	InlineObject.inlineObjectProperties (object)	The properties of this inline object.
InlineObject.inlineObjectProperties.embeddedObject	api_schema_field	Embedded Object	InlineObjectProperties.embeddedObject (object)	The embedded object of this inline object.
InlineObject.inlineObjectProperties.embeddedObject.marginTop	api_schema_field	Margin Top	EmbeddedObject.marginTop (object)	The top margin of the embedded object.
InlineObject.inlineObjectProperties.embeddedObject.marginTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
InlineObject.inlineObjectProperties.embeddedObject.marginTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
InlineObject.inlineObjectProperties.embeddedObject.marginRight	api_schema_field	Margin Right	EmbeddedObject.marginRight (object)	The right margin of the embedded object.
InlineObject.inlineObjectProperties.embeddedObject.marginRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
InlineObject.inlineObjectProperties.embeddedObject.marginRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
InlineObject.inlineObjectProperties.embeddedObject.linkedContentReference	api_schema_field	Linked Content Reference	EmbeddedObject.linkedContentReference (object)	A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
InlineObject.inlineObjectProperties.embeddedObject.linkedContentReference.sheetsChartReference	api_schema_field	Sheets Chart Reference	LinkedContentReference.sheetsChartReference (object)	A reference to the linked chart.
InlineObject.inlineObjectProperties.embeddedObject.embeddedObjectBorder	api_schema_field	Embedded Object Border	EmbeddedObject.embeddedObjectBorder (object)	The border of the embedded object.
InlineObject.inlineObjectProperties.embeddedObject.embeddedObjectBorder.color	api_schema_field	Color	EmbeddedObjectBorder.color (object)	The color of the border.
InlineObject.inlineObjectProperties.embeddedObject.embeddedObjectBorder.dashStyle	api_schema_field	Dash Style	EmbeddedObjectBorder.dashStyle (string)	The dash style of the border.
InlineObject.inlineObjectProperties.embeddedObject.embeddedObjectBorder.propertyState	api_schema_field	Property State	EmbeddedObjectBorder.propertyState (string)	The property state of the border property.
InlineObject.inlineObjectProperties.embeddedObject.embeddedObjectBorder.width	api_schema_field	Width	EmbeddedObjectBorder.width (object)	The width of the border.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties	api_schema_field	Image Properties	EmbeddedObject.imageProperties (object)	The properties of an image.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.cropProperties	api_schema_field	Crop Properties	ImageProperties.cropProperties (object)	The crop properties of the image.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.brightness	api_schema_field	Brightness	ImageProperties.brightness (number)	The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.contrast	api_schema_field	Contrast	ImageProperties.contrast (number)	The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.angle	api_schema_field	Angle	ImageProperties.angle (number)	The clockwise rotation angle of the image, in radians.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.sourceUri	api_schema_field	Source Uri	ImageProperties.sourceUri (string)	The source URI is the URI used to insert the image. The source URI can be empty.
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.contentUri	api_schema_field	Content Uri	ImageProperties.contentUri (string)	A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings ch…
InlineObject.inlineObjectProperties.embeddedObject.imageProperties.transparency	api_schema_field	Transparency	ImageProperties.transparency (number)	The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
InlineObject.inlineObjectProperties.embeddedObject.marginBottom	api_schema_field	Margin Bottom	EmbeddedObject.marginBottom (object)	The bottom margin of the embedded object.
InlineObject.inlineObjectProperties.embeddedObject.marginBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
InlineObject.inlineObjectProperties.embeddedObject.marginBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
InlineObject.inlineObjectProperties.embeddedObject.title	api_schema_field	Title	EmbeddedObject.title (string)	The title of the embedded object. The `title` and `description` are both combined to display alt text.
InlineObject.inlineObjectProperties.embeddedObject.description	api_schema_field	Description	EmbeddedObject.description (string)	The description of the embedded object. The `title` and `description` are both combined to display alt text.
InlineObject.inlineObjectProperties.embeddedObject.size	api_schema_field	Size	EmbeddedObject.size (object)	The visible size of the image after cropping.
InlineObject.inlineObjectProperties.embeddedObject.size.height	api_schema_field	Height	Size.height (object)	The height of the object.
InlineObject.inlineObjectProperties.embeddedObject.size.width	api_schema_field	Width	Size.width (object)	The width of the object.
InlineObject.inlineObjectProperties.embeddedObject.embeddedDrawingProperties	api_schema_field	Embedded Drawing Properties	EmbeddedObject.embeddedDrawingProperties (object)	The properties of an embedded drawing.
InlineObject.inlineObjectProperties.embeddedObject.marginLeft	api_schema_field	Margin Left	EmbeddedObject.marginLeft (object)	The left margin of the embedded object.
InlineObject.inlineObjectProperties.embeddedObject.marginLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
InlineObject.inlineObjectProperties.embeddedObject.marginLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties	api_schema_field	Positioned Object Properties	PositionedObject.positionedObjectProperties (object)	The properties of this positioned object.
PositionedObject.positionedObjectProperties.positioning	api_schema_field	Positioning	PositionedObjectProperties.positioning (object)	The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
PositionedObject.positionedObjectProperties.positioning.topOffset	api_schema_field	Top Offset	PositionedObjectPositioning.topOffset (object)	The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
PositionedObject.positionedObjectProperties.positioning.topOffset.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.positioning.topOffset.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties.positioning.layout	api_schema_field	Layout	PositionedObjectPositioning.layout (string)	The layout of this positioned object.
PositionedObject.positionedObjectProperties.positioning.leftOffset	api_schema_field	Left Offset	PositionedObjectPositioning.leftOffset (object)	The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
PositionedObject.positionedObjectProperties.positioning.leftOffset.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.positioning.leftOffset.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties.embeddedObject	api_schema_field	Embedded Object	PositionedObjectProperties.embeddedObject (object)	The embedded object of this positioned object.
PositionedObject.positionedObjectProperties.embeddedObject.marginTop	api_schema_field	Margin Top	EmbeddedObject.marginTop (object)	The top margin of the embedded object.
PositionedObject.positionedObjectProperties.embeddedObject.marginTop.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.marginTop.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.marginRight	api_schema_field	Margin Right	EmbeddedObject.marginRight (object)	The right margin of the embedded object.
PositionedObject.positionedObjectProperties.embeddedObject.marginRight.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.marginRight.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.linkedContentReference	api_schema_field	Linked Content Reference	EmbeddedObject.linkedContentReference (object)	A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
PositionedObject.positionedObjectProperties.embeddedObject.linkedContentReference.sheetsChartReference	api_schema_field	Sheets Chart Reference	LinkedContentReference.sheetsChartReference (object)	A reference to the linked chart.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedObjectBorder	api_schema_field	Embedded Object Border	EmbeddedObject.embeddedObjectBorder (object)	The border of the embedded object.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedObjectBorder.color	api_schema_field	Color	EmbeddedObjectBorder.color (object)	The color of the border.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedObjectBorder.dashStyle	api_schema_field	Dash Style	EmbeddedObjectBorder.dashStyle (string)	The dash style of the border.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedObjectBorder.propertyState	api_schema_field	Property State	EmbeddedObjectBorder.propertyState (string)	The property state of the border property.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedObjectBorder.width	api_schema_field	Width	EmbeddedObjectBorder.width (object)	The width of the border.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties	api_schema_field	Image Properties	EmbeddedObject.imageProperties (object)	The properties of an image.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.cropProperties	api_schema_field	Crop Properties	ImageProperties.cropProperties (object)	The crop properties of the image.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.brightness	api_schema_field	Brightness	ImageProperties.brightness (number)	The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.contrast	api_schema_field	Contrast	ImageProperties.contrast (number)	The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.angle	api_schema_field	Angle	ImageProperties.angle (number)	The clockwise rotation angle of the image, in radians.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.sourceUri	api_schema_field	Source Uri	ImageProperties.sourceUri (string)	The source URI is the URI used to insert the image. The source URI can be empty.
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.contentUri	api_schema_field	Content Uri	ImageProperties.contentUri (string)	A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings ch…
PositionedObject.positionedObjectProperties.embeddedObject.imageProperties.transparency	api_schema_field	Transparency	ImageProperties.transparency (number)	The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
PositionedObject.positionedObjectProperties.embeddedObject.marginBottom	api_schema_field	Margin Bottom	EmbeddedObject.marginBottom (object)	The bottom margin of the embedded object.
PositionedObject.positionedObjectProperties.embeddedObject.marginBottom.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.marginBottom.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.title	api_schema_field	Title	EmbeddedObject.title (string)	The title of the embedded object. The `title` and `description` are both combined to display alt text.
PositionedObject.positionedObjectProperties.embeddedObject.description	api_schema_field	Description	EmbeddedObject.description (string)	The description of the embedded object. The `title` and `description` are both combined to display alt text.
PositionedObject.positionedObjectProperties.embeddedObject.size	api_schema_field	Size	EmbeddedObject.size (object)	The visible size of the image after cropping.
PositionedObject.positionedObjectProperties.embeddedObject.size.height	api_schema_field	Height	Size.height (object)	The height of the object.
PositionedObject.positionedObjectProperties.embeddedObject.size.width	api_schema_field	Width	Size.width (object)	The width of the object.
PositionedObject.positionedObjectProperties.embeddedObject.embeddedDrawingProperties	api_schema_field	Embedded Drawing Properties	EmbeddedObject.embeddedDrawingProperties (object)	The properties of an embedded drawing.
PositionedObject.positionedObjectProperties.embeddedObject.marginLeft	api_schema_field	Margin Left	EmbeddedObject.marginLeft (object)	The left margin of the embedded object.
PositionedObject.positionedObjectProperties.embeddedObject.marginLeft.magnitude	api_schema_field	Magnitude	Dimension.magnitude (number)	The magnitude.
PositionedObject.positionedObjectProperties.embeddedObject.marginLeft.unit	api_schema_field	Unit	Dimension.unit (string)	The units for magnitude.
PositionedObject.suggestedInsertionId	api_schema_field	Suggested Insertion Id	PositionedObject.suggestedInsertionId (string)	The suggested insertion ID. If empty, then this is not a suggested insertion.
PositionedObject.suggestedDeletionIds	api_schema_field	Suggested Deletion Ids	PositionedObject.suggestedDeletionIds (array)	The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
PositionedObject.objectId	api_schema_field	Object Id	PositionedObject.objectId (string)	The ID of this positioned object.
PositionedObject.suggestedPositionedObjectPropertiesChanges	api_schema_field	Suggested Positioned Object Properties Changes	PositionedObject.suggestedPositionedObjectPropertiesChanges (object)	The suggested changes to the positioned object properties, keyed by suggestion ID.
NamedRange.name	schema_pii_or_identity_field	Name	NamedRange.name (string)	The name of the named range.
NamedRange.namedRangeId	schema_pii_or_identity_field	Named Range Id	NamedRange.namedRangeId (string)	The ID of the named range.
NamedRange.ranges	schema_pii_or_identity_field	Ranges	NamedRange.ranges (array)	The ranges that belong to this named range.
NamedRange.ranges.endIndex	schema_pii_or_identity_field	End Index	Range.endIndex (integer)	The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
NamedRange.ranges.tabId	schema_pii_or_identity_field	Tab Id	Range.tabId (string)	The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multi…
NamedRange.ranges.segmentId	schema_pii_or_identity_field	Segment Id	Range.segmentId (string)	The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
NamedRange.ranges.startIndex	schema_pii_or_identity_field	Start Index	Range.startIndex (integer)	The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

できる分析

プロンプト例

よくある質問

接続手順

GA4

MCPツール

フィールド

サーチコンソール

MCPツール

フィールド

Microsoft Clarity

MCPツール

フィールド

Google広告

MCPツール

フィールド

LINEヤフー広告

MCPツール

フィールド

Microsoft広告

MCPツール

フィールド

Meta広告

MCPツール

フィールド

Amazon広告

MCPツール

フィールド

Adjust

MCPツール

フィールド

AppsFlyer

MCPツール

フィールド

LINE広告

MCPツール

フィールド

Criteo

MCPツール

フィールド

Singular

MCPツール

フィールド

Apple Search Ads

MCPツール

フィールド

Shopify

MCPツール

フィールド

BASE

MCPツール

フィールド

Rakuten RMS

MCPツール

フィールド

Yahoo!ショッピング

MCPツール

フィールド

Amazon

MCPツール

フィールド

フューチャーショップ

MCPツール

フィールド

YouTube

MCPツール

フィールド

Instagram

MCPツール

フィールド

LINE公式アカウント

MCPツール

フィールド

スプレッドシート

MCPツール

フィールド

Googleドキュメント

MCPツール

フィールド