Module api

Module api 

Source

Structs§

Account
Representation of an account.
AccountAdclientAdunitCreateCall
Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an “AFC” product code. For more info see the AdClient resource. For now, this method can only be used to create DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566
AccountAdclientAdunitGetAdcodeCall
Gets the ad unit code for a given ad unit. For more information, see About the AdSense code and Where to place the ad code in your HTML.
AccountAdclientAdunitGetCall
Gets an ad unit from a specified account and ad client.
AccountAdclientAdunitListCall
Lists all ad units under a specified account and ad client.
AccountAdclientAdunitListLinkedCustomChannelCall
Lists all the custom channels available for an ad unit.
AccountAdclientAdunitPatchCall
Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566
AccountAdclientCustomchannelCreateCall
Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.
AccountAdclientCustomchannelDeleteCall
Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.
AccountAdclientCustomchannelGetCall
Gets information about the selected custom channel.
AccountAdclientCustomchannelListCall
Lists all the custom channels available in an ad client.
AccountAdclientCustomchannelListLinkedAdUnitCall
Lists all the ad units available for a custom channel.
AccountAdclientCustomchannelPatchCall
Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.
AccountAdclientGetAdcodeCall
Gets the AdSense code for a given ad client. This returns what was previously known as the ‘auto ad code’. This is only supported for ad clients with a product_code of AFC. For more information, see About the AdSense code.
AccountAdclientGetCall
Gets the ad client from the given resource name.
AccountAdclientListCall
Lists all the ad clients available in an account.
AccountAdclientUrlchannelGetCall
Gets information about the selected url channel.
AccountAdclientUrlchannelListCall
Lists active url channels.
AccountAlertListCall
Lists all the alerts available in an account.
AccountGetAdBlockingRecoveryTagCall
Gets the ad blocking recovery tag of an account.
AccountGetCall
Gets information about the selected AdSense account.
AccountListCall
Lists all accounts available to this user.
AccountListChildAccountCall
Lists all accounts directly managed by the given AdSense account.
AccountMethods
A builder providing access to all methods supported on account resources. It is not used directly, but through the Adsense hub.
AccountPaymentListCall
Lists all the payments available for an account.
AccountPolicyIssueGetCall
Gets information about the selected policy issue.
AccountPolicyIssueListCall
Lists all the policy issues where the specified account is involved, both directly and through any AFP child accounts.
AccountReportGenerateCall
Generates an ad hoc report.
AccountReportGenerateCsvCall
Generates a csv formatted ad hoc report.
AccountReportGetSavedCall
Gets the saved report from the given resource name.
AccountReportSavedGenerateCall
Generates a saved report.
AccountReportSavedGenerateCsvCall
Generates a csv formatted saved report.
AccountReportSavedListCall
Lists saved reports.
AccountSiteGetCall
Gets information about the selected site.
AccountSiteListCall
Lists all the sites available in an account.
AdBlockingRecoveryTag
Representation of an ad blocking recovery tag. See https://support.google.com/adsense/answer/11575177.
AdClient
Representation of an ad client. An ad client represents a user’s subscription with a specific AdSense product.
AdClientAdCode
Representation of the AdSense code for a given ad client. For more information, see About the AdSense code.
AdUnit
Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
AdUnitAdCode
Representation of the ad unit code for a given ad unit. For more information, see About the AdSense code and Where to place the ad code in your HTML.
Adsense
Central instance to access all Adsense related resource activities
Alert
Representation of an alert.
Cell
Cell representation.
ContentAdsSettings
Settings specific to content ads (AFC).
CustomChannel
Representation of a custom channel.
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Header
The header information of the columns requested in the report.
HttpBody
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can’t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
ListAccountsResponse
Response definition for the account list rpc.
ListAdClientsResponse
Response definition for the ad client list rpc.
ListAdUnitsResponse
Response definition for the adunit list rpc.
ListAlertsResponse
Response definition for the alerts list rpc.
ListChildAccountsResponse
Response definition for the child account list rpc.
ListCustomChannelsResponse
Response definition for the custom channel list rpc.
ListLinkedAdUnitsResponse
Response definition for the ad units linked to a custom channel list rpc.
ListLinkedCustomChannelsResponse
Response definition for the custom channels linked to an adunit list rpc.
ListPaymentsResponse
Response definition for the payments list rpc.
ListPolicyIssuesResponse
Response definition for the policy issues list rpc. Policy issues are reported only if the publisher has at least one AFC ad client in READY or GETTING_READY state. If the publisher has no such AFC ad client, the response will be an empty list.
ListSavedReportsResponse
Response definition for the saved reports list rpc.
ListSitesResponse
Response definition for the sites list rpc.
ListUrlChannelsResponse
Response definition for the url channels list rpc.
Payment
Representation of an unpaid or paid payment. See Payment timelines for AdSense for more information about payments and the YouTube homepage and payments account article for information about dedicated payments accounts for YouTube.
PolicyIssue
Representation of a policy issue for a single entity (site, site-section, or page). All issues for a single entity are represented by a single PolicyIssue resource, though that PolicyIssue can have multiple causes (or “topics”) that can change over time. Policy issues are removed if there are no issues detected recently or if there’s a recent successful appeal for the entity.
PolicyTopic
Information about a particular policy topic. A policy topic represents a single class of policy issue that can impact ad serving for your site. For example, sexual content or having ads that obscure your content. A single policy issue can have multiple policy topics for a single entity.
ReportResult
Result of a generated report.
Row
Row representation.
SavedReport
Representation of a saved report.
Site
Representation of a Site.
TimeZone
Represents a time zone from the IANA Time Zone Database.
UrlChannel
Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see URL channels for more information.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.