Skip to main content
Google AdSense logo
  • Category: ads & conversion
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 33
  • Triggers: 0
  • Slug: GOOGLE_ADSENSE
  • Version: 00000000_00

Tools

Slug: GOOGLE_ADSENSE_CREATE_AD_UNITCreate a permanent DISPLAY ad unit under an AFC ad client. AdSense does not provide an ad-unit deletion method. This operation requires a Google Cloud project enabled for AdSense for Platforms.

Input Parameters

string ("ACTIVE" | "ARCHIVED")
required
Initial ad unit state.
string
required
Display name for the new ad unit.
string
required
Complete parent ad client resource name, in the format accounts/{account}/adclients/{adclient}.
object
required
Content ad settings with the required size and DISPLAY type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_CREATE_CUSTOM_CHANNELCreate a custom channel under an ad client. This operation requires a Google Cloud project enabled for AdSense for Platforms.

Input Parameters

boolean
Whether the channel is active and collecting data.
string
required
Display name for the custom channel.
string
required
Complete parent ad client resource name, in the format accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_DELETE_CUSTOM_CHANNELPermanently delete a Google AdSense custom channel. This destructive operation requires a Google Cloud project enabled for AdSense for Platforms.

Input Parameters

string
required
Complete custom channel resource name in the form accounts/{account}/adclients/{adclient}/customchannels/{customchannel}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GENERATE_REPORTGenerate an ad hoc AdSense report as structured JSON rows.

Input Parameters

integer
Maximum number of report rows to return (1-100000).
array
Filters that must all match. Each item is sent as a repeated query key.
array
required
Required report metrics. Each item is sent as a repeated query key.
array
Dimension or metric names to sort by, optionally prefixed with + or -. Each item is sent as a repeated query key.
string ("REPORTING_DATE_RANGE_UNSPECIFIED" | "CUSTOM" | "TODAY" | "YESTERDAY" | "MONTH_TO_DATE" | "YEAR_TO_DATE" | "LAST_7_DAYS" | "LAST_30_DAYS")
Report date range. CUSTOM, including the provider default when omitted, requires every start_date and end_date component.
array
Dimensions used to group rows. Each item is sent as a repeated query key.
string
required
Complete account resource name, in the format accounts/{account}.
integer
End day (0-31); use 0 for a year or year/month date.
string
ISO-4217 currency code. Omit it to use the account currency.
integer
End year (0-9999); use 0 for a month/day without a year.
string
IETF BCP-47 language code for translated report output.
integer
End month (0-12); use 0 only for a year-only date.
integer
Start day (0-31); use 0 for a year or year/month date.
integer
Start year (0-9999); use 0 for a month/day without a year.
integer
Start month (0-12); use 0 only for a year-only date.
string ("REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE")
Timezone used to generate the report. Omit it for the account timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GENERATE_REPORT_CSVGenerate an ad hoc AdSense report and return its CSV text verbatim.

Input Parameters

integer
Maximum report rows to return (1-1,000,000). Extra rows are truncated.
array
Filters that must all match. Values are sent as repeated filters query keys.
array
required
Metrics to include. Values are sent as repeated metrics query keys.
array
Dimensions or metrics to sort by, optionally prefixed with + or -. Values are sent as repeated orderBy query keys.
string ("REPORTING_DATE_RANGE_UNSPECIFIED" | "CUSTOM" | "TODAY" | "YESTERDAY" | "MONTH_TO_DATE" | "YEAR_TO_DATE" | "LAST_7_DAYS" | "LAST_30_DAYS")
Report date range. CUSTOM, including the provider default when omitted, requires every start_date and end_date component.
array
Dimensions to group rows by. Values are sent as repeated dimensions query keys.
string
required
Complete account resource name, for example accounts/pub-123.
integer
End day (0-31).
string
ISO-4217 currency code; defaults to the account currency.
integer
End year (0-9999).
string
IETF BCP-47 language code for translated output; defaults to English.
integer
End month (0-12).
integer
Start day (0-31).
integer
Start year (0-9999).
integer
Start month (0-12).
string ("REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE")
Timezone used to generate the report; defaults to the account timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GENERATE_SAVED_REPORTRun a publisher-created saved report and return structured JSON rows.

Input Parameters

string ("REPORTING_DATE_RANGE_UNSPECIFIED" | "CUSTOM" | "TODAY" | "YESTERDAY" | "MONTH_TO_DATE" | "YEAR_TO_DATE" | "LAST_7_DAYS" | "LAST_30_DAYS")
Report date range. CUSTOM, including the provider default when omitted, requires every start_date and end_date component.
integer
End day for a CUSTOM date range.
string
ISO-4217 currency code; defaults to the account currency.
integer
End year for a CUSTOM date range.
string
IETF BCP-47 language code for translated output; defaults to English.
integer
End month for a CUSTOM date range.
integer
Start day for a CUSTOM date range.
integer
Start year for a CUSTOM date range.
integer
Start month for a CUSTOM date range.
string
required
Complete saved report resource name, in the format accounts/{account}/reports/{report}.
string ("REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE")
Timezone used to generate the report; defaults to the account timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GENERATE_SAVED_REPORT_CSVRun a publisher-created saved AdSense report and return CSV text.

Input Parameters

string ("REPORTING_DATE_RANGE_UNSPECIFIED" | "CUSTOM" | "TODAY" | "YESTERDAY" | "MONTH_TO_DATE" | "YEAR_TO_DATE" | "LAST_7_DAYS" | "LAST_30_DAYS")
Report date range. CUSTOM, including the provider default when omitted, requires every start_date and end_date component.
integer
End day for a CUSTOM date range.
string
ISO-4217 currency code; defaults to the account currency.
integer
End year for a CUSTOM date range.
string
IETF BCP-47 language code for translated output; defaults to English.
integer
End month for a CUSTOM date range.
integer
Start day for a CUSTOM date range.
integer
Start year for a CUSTOM date range.
integer
Start month for a CUSTOM date range.
string
required
Complete saved report resource name in the form accounts/{account}/reports/{report}.
string ("REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE")
Timezone used to generate the report; defaults to the account timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_ACCOUNTReturn one AdSense account’s state, setup tasks, timezone, and premium status.

Input Parameters

string
required
Complete account resource name in the form accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_AD_BLOCKING_RECOVERY_TAGReturn an account’s ad blocking recovery tag and its optional error-protection code.

Input Parameters

string
required
Complete account resource name in the form accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_AD_CLIENTReturn one ad client by its complete resource name.

Input Parameters

string
required
Complete ad client resource name in the form accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_AD_CLIENT_CODEReturn standard and AMP AdSense code snippets for an AFC ad client.

Input Parameters

string
required
Complete AFC ad client resource name in the form accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_AD_UNITReturn one Google AdSense ad unit by its complete resource name.

Input Parameters

string
required
Complete ad unit resource name in the form accounts/{account}/adclients/{adclient}/adunits/{adunit}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_AD_UNIT_CODEReturn the complete HTML code snippet for one Google AdSense ad unit.

Input Parameters

string
required
Complete ad unit resource name in the form accounts/{account}/adclients/{adclient}/adunits/{adunit}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_CUSTOM_CHANNELReturn one custom channel by its complete resource name.

Input Parameters

string
required
Complete custom channel resource name in the form accounts/{account}/adclients/{adclient}/customchannels/{customchannel}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_POLICY_ISSUEReturn one AdSense policy issue and all of its enforcement details.

Input Parameters

string
required
Complete policy issue resource name in the form accounts/{account}/policyIssues/{policy_issue}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_SAVED_REPORTReturn one saved report’s complete resource name and title.

Input Parameters

string
required
Complete saved report resource name in the form accounts/{account}/reports/{report}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_SITEReturn one AdSense site by its complete resource name.

Input Parameters

string
required
Complete site resource name in the form accounts/{account}/sites/{site}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_GET_URL_CHANNELReturn one URL channel by its complete resource name.

Input Parameters

string
required
Complete URL channel resource name in the form accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_ACCOUNTSReturn one page of AdSense accounts available to the connected user.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original page_size automatically.
integer
Maximum accounts in this page. Google coerces values above 10000 to 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_AD_CLIENTSReturn one page of ad clients available in an AdSense account.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original account and page_size.
integer
Maximum ad clients in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_AD_UNIT_CUSTOM_CHANNELSReturn one page of custom channels linked to an AdSense ad unit.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original ad unit and page_size.
integer
Maximum linked custom channels in this page. Google coerces values above 10000 to 10000.
string
required
Complete ad unit resource name: accounts/{account}/adclients/{adclient}/adunits/{adunit}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_AD_UNITSReturn one page of ad units owned by an AdSense ad client.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original ad client and page_size.
integer
Maximum ad units in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent ad client resource name: accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_ALERTSReturn AdSense account alerts localized to an optional language.

Input Parameters

string
required
Complete parent account resource name: accounts/{account}.
string
IETF BCP-47 language code for alert messages. Unsupported values fall back to English; omission uses the user’s display language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_CHILD_ACCOUNTSReturn one page of accounts directly managed by a parent AdSense account.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original account and page_size.
integer
Maximum child accounts in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_CUSTOM_CHANNEL_AD_UNITSReturn one page of ad units linked to a custom channel.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original custom channel and page_size.
integer
Maximum linked ad units in this page. Google coerces values above 10000 to 10000.
string
required
Complete custom channel resource name: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_CUSTOM_CHANNELSReturn one page of custom channels owned by an AdSense ad client.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original ad client and page_size.
integer
Maximum custom channels in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent ad client resource name: accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_PAYMENTSReturn paid and unpaid payment records available for an AdSense account.

Input Parameters

string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_POLICY_ISSUESReturn one page of policy issues affecting an account or its AFP children.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original account and page_size.
integer
Maximum policy issues in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_SAVED_REPORTSReturn one page of publisher-created saved reports for an account.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original account and page_size.
integer
Maximum saved reports in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_SITESReturn one page of sites available in an AdSense account.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original account and page_size.
integer
Maximum sites in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent account resource name: accounts/{account}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_LIST_URL_CHANNELSReturn one page of active URL channels owned by an AdSense ad client.

Input Parameters

string
Opaque continuation cursor returned as next_cursor by a previous call. Pass it back unchanged; it restores the original ad client and page_size.
integer
Maximum URL channels in this page. Google coerces values above 10000 to 10000.
string
required
Complete parent ad client resource name: accounts/{account}/adclients/{adclient}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_UPDATE_AD_UNITReplace all writable settings of a DISPLAY ad unit. This operation requires a Google Cloud project enabled for AdSense for Platforms.

Input Parameters

string ("ACTIVE" | "ARCHIVED")
required
Complete replacement state.
string
required
Complete ad unit resource name: accounts/{account}/adclients/{adclient}/adunits/{adunit}.
string
required
Complete replacement display name.
object
required
Complete replacement content ad settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADSENSE_UPDATE_CUSTOM_CHANNELReplace all writable settings of a custom channel. This operation requires a Google Cloud project enabled for AdSense for Platforms.

Input Parameters

boolean
required
Complete replacement active state.
string
required
Complete replacement display name.
string
required
Complete custom channel resource name: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not