+ get(id)
Gets one account by ID.
+
+ list()
Retrieves the authenticated user's list of accounts.
+ +Updates an existing account. This method supports patch semantics.
+ +Updates an existing account.
+get(id)
+ Gets one account by ID.
+
+Args:
+ id: integer, The account id (required)
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+list()
+ Retrieves the authenticated user's list of accounts.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ { # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
+ "items": [ # A list of accounts.
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ },
+ ],
+ "kind": "adexchangebuyer#accountsList", # Resource type.
+ }
+patch(id, body)
+ Updates an existing account. This method supports patch semantics.
+
+Args:
+ id: integer, The account id (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+update(id, body)
+ Updates an existing account.
+
+Args:
+ id: integer, The account id (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+
+ get(accountId, buyerCreativeId)
Gets the status for a single creative.
+ +Submit a new creative.
+
+ list(pageToken=None, maxResults=None, statusFilter=None)
Retrieves a list of the authenticated user's active creatives.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, buyerCreativeId)
+ Gets the status for a single creative.
+
+Args:
+ accountId: integer, The id for the account that will serve this creative. (required)
+ buyerCreativeId: string, The buyer-specific id for this creative. (required)
+
+Returns:
+ An object of the form:
+
+ { # A creative and its classification data.
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "agencyId": "A String", # The agency id for this creative.
+ "width": 42, # Ad width.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "accountId": 42, # Account id.
+ }
+insert(body)
+ Submit a new creative.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A creative and its classification data.
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "agencyId": "A String", # The agency id for this creative.
+ "width": 42, # Ad width.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "accountId": 42, # Account id.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A creative and its classification data.
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "agencyId": "A String", # The agency id for this creative.
+ "width": 42, # Ad width.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "accountId": 42, # Account id.
+ }
+list(pageToken=None, maxResults=None, statusFilter=None)
+ Retrieves a list of the authenticated user's active creatives.
+
+Args:
+ pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
+ maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
+ statusFilter: string, When specified, only creatives having the given status are returned.
+ Allowed values
+ approved - Creatives which have been approved.
+ disapproved - Creatives which have been disapproved.
+ not_checked - Creatives whose status is not yet checked.
+
+Returns:
+ An object of the form:
+
+ { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
+ "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # A list of creatives.
+ { # A creative and its classification data.
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "agencyId": "A String", # The agency id for this creative.
+ "width": 42, # Ad width.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "accountId": 42, # Account id.
+ },
+ ],
+ "kind": "adexchangebuyer#creativesList", # Resource type.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ get(id)
Gets one direct deal by ID.
+
+ list()
Retrieves the authenticated user's list of direct deals.
+get(id)
+ Gets one direct deal by ID.
+
+Args:
+ id: string, The direct deal id (required)
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for an Ad Exchange direct deal.
+ "advertiser": "A String", # The name of the advertiser this deal is for.
+ "kind": "adexchangebuyer#directDeal", # Resource type.
+ "privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
+ "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
+ "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
+ "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
+ "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
+ "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
+ "id": "A String", # Deal id.
+ "accountId": 42, # The account id of the buyer this deal is for.
+ }
+list()
+ Retrieves the authenticated user's list of direct deals.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ { # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
+ "kind": "adexchangebuyer#directDealsList", # Resource type.
+ "directDeals": [ # A list of direct deals relevant for your account.
+ { # The configuration data for an Ad Exchange direct deal.
+ "advertiser": "A String", # The name of the advertiser this deal is for.
+ "kind": "adexchangebuyer#directDeal", # Resource type.
+ "privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
+ "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
+ "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
+ "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
+ "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
+ "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
+ "id": "A String", # Deal id.
+ "accountId": 42, # The account id of the buyer this deal is for.
+ },
+ ],
+ }
+
+ accounts()
+
Returns the accounts Resource.
+ +
+ creatives()
+
Returns the creatives Resource.
+ +
+ directDeals()
+
Returns the directDeals Resource.
+ + +Returns the performanceReport Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/adexchangebuyer_v1_2.performanceReport.html b/docs/dyn/adexchangebuyer_v1_2.performanceReport.html new file mode 100644 index 0000000..63f9f2d --- /dev/null +++ b/docs/dyn/adexchangebuyer_v1_2.performanceReport.html @@ -0,0 +1,108 @@ + + + +
+ list(accountId, endDateTime, startDateTime)
Retrieves the authenticated user's list of performance metrics.
+list(accountId, endDateTime, startDateTime)
+ Retrieves the authenticated user's list of performance metrics.
+
+Args:
+ accountId: string, The account id to get the reports for. (required)
+ endDateTime: string, The end time for the reports. (required)
+ startDateTime: string, The start time for the reports. (required)
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for an Ad Exchange performance report list. TODO(nathanbullock): need to add some release tests before releasing this. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
+ "kind": "adexchangebuyer#performanceReportList", # Resource type.
+ "performance_report": [ # A list of performance reports relevant for the account.
+ {
+ "kind": "adexchangebuyer#performanceReport", # Resource type.
+ "timestamp": "A String", # Timestamp of the starting time of this performance data.
+ "region": "A String", # The trading location of this data.
+ "latency50thPercentile": 3.14, # The Nth percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
+ "latency85thPercentile": 3.14,
+ "latency95thPercentile": 3.14,
+ },
+ ],
+ }
+Retrieves a list of activities for a specific customer and application.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)
+ Retrieves a list of activities for a specific customer and application.
+
+Args:
+ userKey: string, Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. (required)
+ applicationName: string, Application name for which the events are to be retrieved. (required)
+ eventName: string, Name of the event being queried.
+ actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
+ filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
+ maxResults: integer, Number of activity records to be shown in each page.
+ pageToken: string, Token to specify next page.
+ startTime: string, Return events which occured at or after this time.
+ endTime: string, Return events which occured at or before this time.
+
+Returns:
+ An object of the form:
+
+ { # JSON template for a collection of activites.
+ "nextPageToken": "A String", # Token for retrieving the next page
+ "items": [ # Each record in read response.
+ { # JSON template for the activity resource.
+ "kind": "admin#reports#activity", # Kind of resource this is.
+ "ownerDomain": "A String", # Domain of source customer.
+ "actor": { # User doing the action.
+ "profileId": "A String", # Obfuscated user id of the user.
+ "email": "A String", # Email address of the user.
+ "key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
+ "callerType": "A String", # User or OAuth 2LO request.
+ },
+ "id": { # Unique identifier for each activity record.
+ "applicationName": "A String", # Application name to which the event belongs.
+ "uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time.
+ "customerId": "A String", # Obfuscated customer ID of the source customer.
+ "time": "A String", # Time of occurrence of the activity.
+ },
+ "ipAddress": "A String", # IP Address of the user doing the action.
+ "events": [ # Activity events.
+ {
+ "type": "A String", # Type of event.
+ "name": "A String", # Name of event.
+ "parameters": [ # Parameter value pairs for various applications.
+ {
+ "boolValue": True or False, # Boolean value of the parameter.
+ "intValue": "A String", # Integral value of the parameter.
+ "value": "A String", # String value of the parameter.
+ "name": "A String", # The name of the parameter.
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "kind": "admin#reports#activities", # Kind of list response this is.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ get(date, pageToken=None, parameters=None)
Retrieves a report which is a collection of properties / statistics for a specific customer.
+
+ get_next(previous_request, previous_response)
Retrieves the next page of results.
+get(date, pageToken=None, parameters=None)
+ Retrieves a report which is a collection of properties / statistics for a specific customer.
+
+Args:
+ date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
+ pageToken: string, Token to specify next page.
+ parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
+
+Returns:
+ An object of the form:
+
+ { # JSON template for a collection of usage reports.
+ "nextPageToken": "A String", # Token for retrieving the next page
+ "kind": "admin#reports#usageReports", # The kind of object.
+ "usageReports": [ # Various application parameter records.
+ { # JSON template for a usage report.
+ "date": "A String", # The date to which the record belongs.
+ "kind": "admin#reports#usageReport", # The kind of object.
+ "parameters": [ # Parameter value pairs for various applications.
+ {
+ "stringValue": "A String", # String value of the parameter.
+ "boolValue": True or False, # Boolean value of the parameter.
+ "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
+ "intValue": "A String", # Integral value of the parameter.
+ "name": "A String", # The name of the parameter.
+ },
+ ],
+ "entity": { # Information about the type of the item.
+ "profileId": "A String", # Obfuscated user id for the record.
+ "userEmail": "A String", # user's email.
+ "type": "A String", # The type of item, can be a customer or user.
+ "customerId": "A String", # Obfuscated customer id for the record.
+ },
+ },
+ ],
+ "warnings": [ # Warnings if any.
+ {
+ "message": "A String", # Human readable message for the warning.
+ "code": "A String", # Machine readable code / warning type.
+ "data": [ # Key-Value pairs to give detailed information on the warning.
+ {
+ "value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
+ "key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
+ },
+ ],
+ },
+ ],
+ }
+get_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ activities()
+
Returns the activities Resource.
+ + +Returns the customerUsageReports Resource.
+ + +Returns the userUsageReport Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/admin_reports_v1.userUsageReport.html b/docs/dyn/admin_reports_v1.userUsageReport.html new file mode 100644 index 0000000..fdeaf57 --- /dev/null +++ b/docs/dyn/admin_reports_v1.userUsageReport.html @@ -0,0 +1,152 @@ + + + +
+ get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)
Retrieves a report which is a collection of properties / statistics for a set of users.
+
+ get_next(previous_request, previous_response)
Retrieves the next page of results.
+get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)
+ Retrieves a report which is a collection of properties / statistics for a set of users.
+
+Args:
+ userKey: string, Represents the profile id or the user email for which the data should be filtered. (required)
+ date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
+ parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
+ pageToken: string, Token to specify next page.
+ filters: string, Represents the set of filters including parameter operator value.
+ maxResults: integer, Maximum number of results to return. Maximum allowed is 1000
+
+Returns:
+ An object of the form:
+
+ { # JSON template for a collection of usage reports.
+ "nextPageToken": "A String", # Token for retrieving the next page
+ "kind": "admin#reports#usageReports", # The kind of object.
+ "usageReports": [ # Various application parameter records.
+ { # JSON template for a usage report.
+ "date": "A String", # The date to which the record belongs.
+ "kind": "admin#reports#usageReport", # The kind of object.
+ "parameters": [ # Parameter value pairs for various applications.
+ {
+ "stringValue": "A String", # String value of the parameter.
+ "boolValue": True or False, # Boolean value of the parameter.
+ "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
+ "intValue": "A String", # Integral value of the parameter.
+ "name": "A String", # The name of the parameter.
+ },
+ ],
+ "entity": { # Information about the type of the item.
+ "profileId": "A String", # Obfuscated user id for the record.
+ "userEmail": "A String", # user's email.
+ "type": "A String", # The type of item, can be a customer or user.
+ "customerId": "A String", # Obfuscated customer id for the record.
+ },
+ },
+ ],
+ "warnings": [ # Warnings if any.
+ {
+ "message": "A String", # Human readable message for the warning.
+ "code": "A String", # Machine readable code / warning type.
+ "data": [ # Key-Value pairs to give detailed information on the warning.
+ {
+ "value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
+ "key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
+ },
+ ],
+ },
+ ],
+ }
+get_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(accountId, pageToken=None, maxResults=None)
List all ad clients in the specified account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(accountId, pageToken=None, maxResults=None)
+ List all ad clients in the specified account.
+
+Args:
+ accountId: string, Account for which to list ad clients. (required)
+ pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad clients returned in this list response.
+ {
+ "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
+ "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
+ "id": "A String", # Unique identifier of this ad client.
+ "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
+ "supportsReporting": True or False, # Whether this ad client supports being reported on.
+ },
+ ],
+ "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
List all custom channels which the specified ad unit belongs to.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
+ List all custom channels which the specified ad unit belongs to.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client which contains the ad unit. (required)
+ adUnitId: string, Ad unit for which to list custom channels. (required)
+ pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The custom channels returned in this list response.
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ },
+ ],
+ "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ customchannels()
+
Returns the customchannels Resource.
+ +
+ get(accountId, adClientId, adUnitId)
Gets the specified ad unit in the specified ad client for the specified account.
+
+ getAdCode(accountId, adClientId, adUnitId)
Get ad code for the specified ad unit.
+
+ list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified ad client for the specified account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, adClientId, adUnitId)
+ Gets the specified ad unit in the specified ad client for the specified account.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client for which to get the ad unit. (required)
+ adUnitId: string, Ad unit to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ }
+getAdCode(accountId, adClientId, adUnitId)
+ Get ad code for the specified ad unit.
+
+Args:
+ accountId: string, Account which contains the ad client. (required)
+ adClientId: string, Ad client with contains the ad unit. (required)
+ adUnitId: string, Ad unit to get the code for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "adCode": "A String", # The ad code snippet.
+ "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
+ }
+list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
+ List all ad units in the specified ad client for the specified account.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client for which to list ad units. (required)
+ pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ includeInactive: boolean, Whether to include inactive ad units. Default: true.
+ maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad units returned in this list response.
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ },
+ ],
+ "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(accountId, locale=None)
List the alerts for the specified AdSense account.
+list(accountId, locale=None)
+ List the alerts for the specified AdSense account.
+
+Args:
+ accountId: string, Account for which to retrieve the alerts. (required)
+ locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The alerts returned in this list response.
+ {
+ "type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
+ "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
+ "message": "A String", # The localized alert message.
+ "id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
+ },
+ ],
+ "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
+ }
+
+ list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified custom channel.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
+ List all ad units in the specified custom channel.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client which contains the custom channel. (required)
+ customChannelId: string, Custom channel for which to list ad units. (required)
+ pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ includeInactive: boolean, Whether to include inactive ad units. Default: true.
+ maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad units returned in this list response.
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ },
+ ],
+ "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ adunits()
+
Returns the adunits Resource.
+ +
+ get(accountId, adClientId, customChannelId)
Get the specified custom channel from the specified ad client for the specified account.
+
+ list(accountId, adClientId, pageToken=None, maxResults=None)
List all custom channels in the specified ad client for the specified account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, adClientId, customChannelId)
+ Get the specified custom channel from the specified ad client for the specified account.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client which contains the custom channel. (required)
+ customChannelId: string, Custom channel to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ }
+list(accountId, adClientId, pageToken=None, maxResults=None)
+ List all custom channels in the specified ad client for the specified account.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client for which to list custom channels. (required)
+ pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The custom channels returned in this list response.
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ },
+ ],
+ "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ adclients()
+
Returns the adclients Resource.
+ +
+ adunits()
+
Returns the adunits Resource.
+ +
+ alerts()
+
Returns the alerts Resource.
+ +
+ customchannels()
+
Returns the customchannels Resource.
+ +
+ reports()
+
Returns the reports Resource.
+ +
+ savedadstyles()
+
Returns the savedadstyles Resource.
+ +
+ urlchannels()
+
Returns the urlchannels Resource.
+ + +Get information about the selected AdSense account.
+
+ list(pageToken=None, maxResults=None)
List all accounts available to this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, tree=None)
+ Get information about the selected AdSense account.
+
+Args:
+ accountId: string, Account to get information about. (required)
+ tree: boolean, Whether the tree of sub accounts should be returned.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
+ "premium": True or False, # Whether this account is premium.
+ "id": "A String", # Unique identifier of this account.
+ "subAccounts": [ # Sub accounts of the this account.
+ # Object with schema name: Account
+ ],
+ "name": "A String", # Name of this account.
+ }
+list(pageToken=None, maxResults=None)
+ List all accounts available to this AdSense account.
+
+Args:
+ pageToken: string, A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of accounts to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The accounts returned in this list response.
+ {
+ "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
+ "premium": True or False, # Whether this account is premium.
+ "id": "A String", # Unique identifier of this account.
+ "subAccounts": [ # Sub accounts of the this account.
+ # Object with schema name: Account
+ ],
+ "name": "A String", # Name of this account.
+ },
+ ],
+ "kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ saved()
+
Returns the saved Resource.
+ + +Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+ +Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
+ Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+
+Args:
+ accountId: string, Account upon which to report. (required)
+ startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
+ endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
+ locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
+ metric: string, Numeric columns to include in the report. (repeated)
+ currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+ startIndex: integer, Index of the first row of report data to return.
+ useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
+ sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+ maxResults: integer, The maximum number of rows of report data to return.
+ filter: string, Filters to be run on the report. (repeated)
+ dimension: string, Dimensions to base the report on. (repeated)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#report", # Kind this is, in this case adsense#report.
+ "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
+ [
+ "A String",
+ ],
+ ],
+ "warnings": [ # Any warnings associated with generation of the report.
+ "A String",
+ ],
+ "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
+ {
+ "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
+ "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
+ "name": "A String", # The name of the header.
+ },
+ ],
+ "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
+ "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ }
+generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
+ Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. + +Args: + accountId: string, Account upon which to report. (required) + startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) + endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) + locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. + metric: string, Numeric columns to include in the report. (repeated) + currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. + startIndex: integer, Index of the first row of report data to return. + useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. + sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) + maxResults: integer, The maximum number of rows of report data to return. + filter: string, Filters to be run on the report. (repeated) + dimension: string, Dimensions to base the report on. (repeated) + +Returns: + The media object as a string. + ++
+ generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
Generate an AdSense report based on the saved report ID sent in the query parameters.
+
+ list(accountId, pageToken=None, maxResults=None)
List all saved reports in the specified AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
+ Generate an AdSense report based on the saved report ID sent in the query parameters.
+
+Args:
+ accountId: string, Account to which the saved reports belong. (required)
+ savedReportId: string, The saved report to retrieve. (required)
+ locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
+ maxResults: integer, The maximum number of rows of report data to return.
+ startIndex: integer, Index of the first row of report data to return.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#report", # Kind this is, in this case adsense#report.
+ "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
+ [
+ "A String",
+ ],
+ ],
+ "warnings": [ # Any warnings associated with generation of the report.
+ "A String",
+ ],
+ "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
+ {
+ "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
+ "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
+ "name": "A String", # The name of the header.
+ },
+ ],
+ "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
+ "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ }
+list(accountId, pageToken=None, maxResults=None)
+ List all saved reports in the specified AdSense account.
+
+Args:
+ accountId: string, Account to which the saved reports belong. (required)
+ pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The saved reports returned in this list response.
+ {
+ "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
+ "id": "A String", # Unique identifier of this saved report.
+ "name": "A String", # This saved report's name.
+ },
+ ],
+ "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ get(accountId, savedAdStyleId)
List a specific saved ad style for the specified account.
+
+ list(accountId, pageToken=None, maxResults=None)
List all saved ad styles in the specified account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, savedAdStyleId)
+ List a specific saved ad style for the specified account.
+
+Args:
+ accountId: string, Account for which to get the saved ad style. (required)
+ savedAdStyleId: string, Saved ad style to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
+ "adStyle": { # The AdStyle itself.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ "name": "A String", # The user selected name of this SavedAdStyle.
+ "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ }
+list(accountId, pageToken=None, maxResults=None)
+ List all saved ad styles in the specified account.
+
+Args:
+ accountId: string, Account for which to list saved ad styles. (required)
+ pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The saved ad styles returned in this list response.
+ {
+ "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
+ "adStyle": { # The AdStyle itself.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ "name": "A String", # The user selected name of this SavedAdStyle.
+ "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ },
+ ],
+ "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(accountId, adClientId, pageToken=None, maxResults=None)
List all URL channels in the specified ad client for the specified account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(accountId, adClientId, pageToken=None, maxResults=None)
+ List all URL channels in the specified ad client for the specified account.
+
+Args:
+ accountId: string, Account to which the ad client belongs. (required)
+ adClientId: string, Ad client for which to list URL channels. (required)
+ pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The URL channels returned in this list response.
+ {
+ "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
+ "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
+ },
+ ],
+ "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(pageToken=None, maxResults=None)
List all ad clients in this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(pageToken=None, maxResults=None)
+ List all ad clients in this AdSense account.
+
+Args:
+ pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad clients returned in this list response.
+ {
+ "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
+ "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
+ "id": "A String", # Unique identifier of this ad client.
+ "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
+ "supportsReporting": True or False, # Whether this ad client supports being reported on.
+ },
+ ],
+ "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(adClientId, adUnitId, pageToken=None, maxResults=None)
List all custom channels which the specified ad unit belongs to.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(adClientId, adUnitId, pageToken=None, maxResults=None)
+ List all custom channels which the specified ad unit belongs to.
+
+Args:
+ adClientId: string, Ad client which contains the ad unit. (required)
+ adUnitId: string, Ad unit for which to list custom channels. (required)
+ pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The custom channels returned in this list response.
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ },
+ ],
+ "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ customchannels()
+
Returns the customchannels Resource.
+ + +Gets the specified ad unit in the specified ad client.
+
+ getAdCode(adClientId, adUnitId)
Get ad code for the specified ad unit.
+
+ list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified ad client for this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(adClientId, adUnitId)
+ Gets the specified ad unit in the specified ad client.
+
+Args:
+ adClientId: string, Ad client for which to get the ad unit. (required)
+ adUnitId: string, Ad unit to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ }
+getAdCode(adClientId, adUnitId)
+ Get ad code for the specified ad unit.
+
+Args:
+ adClientId: string, Ad client with contains the ad unit. (required)
+ adUnitId: string, Ad unit to get the code for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "adCode": "A String", # The ad code snippet.
+ "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
+ }
+list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
+ List all ad units in the specified ad client for this AdSense account.
+
+Args:
+ adClientId: string, Ad client for which to list ad units. (required)
+ pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ includeInactive: boolean, Whether to include inactive ad units. Default: true.
+ maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad units returned in this list response.
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ },
+ ],
+ "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
List the alerts for this AdSense account.
+list(locale=None)
+ List the alerts for this AdSense account.
+
+Args:
+ locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The alerts returned in this list response.
+ {
+ "type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
+ "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
+ "message": "A String", # The localized alert message.
+ "id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
+ },
+ ],
+ "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
+ }
+
+ list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified custom channel.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
+ List all ad units in the specified custom channel.
+
+Args:
+ adClientId: string, Ad client which contains the custom channel. (required)
+ customChannelId: string, Custom channel for which to list ad units. (required)
+ pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ includeInactive: boolean, Whether to include inactive ad units. Default: true.
+ maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The ad units returned in this list response.
+ {
+ "status": "A String", # Status of this ad unit. Possible values are:
+ # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+ #
+ # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+ #
+ # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+ "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "name": "A String", # Name of this ad unit.
+ "feedAdsSettings": { # Settings specific to feed ads (AFF).
+ "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
+ "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
+ "adPosition": "A String", # The position of the ads relative to the feed entries.
+ "type": "A String", # The type of ads which should appear.
+ },
+ "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
+ "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
+ "type": "A String", # Type of this ad unit.
+ "backupOption": { # The backup option to be used in instances where no ad is available.
+ "color": "A String", # Color to use when type is set to COLOR.
+ "url": "A String", # URL to use when type is set to URL.
+ "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
+ },
+ "size": "A String", # Size of this ad unit.
+ },
+ "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
+ "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
+ "type": "A String", # Type of this ad unit.
+ "markupLanguage": "A String", # The markup language to use for this ad unit.
+ "size": "A String", # Size of this ad unit.
+ },
+ "customStyle": { # Custom style information specific to this ad unit.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ },
+ ],
+ "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ adunits()
+
Returns the adunits Resource.
+ +
+ get(adClientId, customChannelId)
Get the specified custom channel from the specified ad client.
+
+ list(adClientId, pageToken=None, maxResults=None)
List all custom channels in the specified ad client for this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(adClientId, customChannelId)
+ Get the specified custom channel from the specified ad client.
+
+Args:
+ adClientId: string, Ad client which contains the custom channel. (required)
+ customChannelId: string, Custom channel to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ }
+list(adClientId, pageToken=None, maxResults=None)
+ List all custom channels in the specified ad client for this AdSense account.
+
+Args:
+ adClientId: string, Ad client for which to list custom channels. (required)
+ pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The custom channels returned in this list response.
+ {
+ "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+ "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+ "targetingInfo": { # The targeting information of this custom channel, if activated.
+ "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
+ "adsAppearOn": "A String", # The name used to describe this channel externally.
+ "siteLanguage": "A String", # The language of the sites ads will be displayed on.
+ "description": "A String", # The external description of the channel.
+ },
+ "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "name": "A String", # Name of this custom channel.
+ },
+ ],
+ "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ accounts()
+
Returns the accounts Resource.
+ +
+ adclients()
+
Returns the adclients Resource.
+ +
+ adunits()
+
Returns the adunits Resource.
+ +
+ alerts()
+
Returns the alerts Resource.
+ +
+ customchannels()
+
Returns the customchannels Resource.
+ +
+ metadata()
+
Returns the metadata Resource.
+ +
+ reports()
+
Returns the reports Resource.
+ +
+ savedadstyles()
+
Returns the savedadstyles Resource.
+ +
+ urlchannels()
+
Returns the urlchannels Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v1_3.metadata.dimensions.html b/docs/dyn/adsense_v1_3.metadata.dimensions.html new file mode 100644 index 0000000..e59c54f --- /dev/null +++ b/docs/dyn/adsense_v1_3.metadata.dimensions.html @@ -0,0 +1,116 @@ + + + +
+ list()
List the metadata for the dimensions available to this AdSense account.
+list()
+ List the metadata for the dimensions available to this AdSense account.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [
+ {
+ "requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
+ "A String",
+ ],
+ "kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
+ "compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
+ "A String",
+ ],
+ "requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
+ "A String",
+ ],
+ "compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
+ "A String",
+ ],
+ "id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
+ "supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
+ "A String",
+ ],
+ },
+ ],
+ "kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
+ }
+
+ dimensions()
+
Returns the dimensions Resource.
+ +
+ metrics()
+
Returns the metrics Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v1_3.metadata.metrics.html b/docs/dyn/adsense_v1_3.metadata.metrics.html new file mode 100644 index 0000000..754349f --- /dev/null +++ b/docs/dyn/adsense_v1_3.metadata.metrics.html @@ -0,0 +1,116 @@ + + + +
+ list()
List the metadata for the metrics available to this AdSense account.
+list()
+ List the metadata for the metrics available to this AdSense account.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [
+ {
+ "requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
+ "A String",
+ ],
+ "kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
+ "compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
+ "A String",
+ ],
+ "requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
+ "A String",
+ ],
+ "compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
+ "A String",
+ ],
+ "id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
+ "supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
+ "A String",
+ ],
+ },
+ ],
+ "kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
+ }
+
+ saved()
+
Returns the saved Resource.
+ + +Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+ +Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
+ Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
+
+Args:
+ startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
+ endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
+ locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
+ metric: string, Numeric columns to include in the report. (repeated)
+ currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+ startIndex: integer, Index of the first row of report data to return.
+ accountId: string, Accounts upon which to report. (repeated)
+ useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
+ sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+ maxResults: integer, The maximum number of rows of report data to return.
+ filter: string, Filters to be run on the report. (repeated)
+ dimension: string, Dimensions to base the report on. (repeated)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#report", # Kind this is, in this case adsense#report.
+ "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
+ [
+ "A String",
+ ],
+ ],
+ "warnings": [ # Any warnings associated with generation of the report.
+ "A String",
+ ],
+ "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
+ {
+ "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
+ "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
+ "name": "A String", # The name of the header.
+ },
+ ],
+ "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
+ "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ }
+generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
+ Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. + +Args: + startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) + endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) + locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. + metric: string, Numeric columns to include in the report. (repeated) + currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. + startIndex: integer, Index of the first row of report data to return. + accountId: string, Accounts upon which to report. (repeated) + useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. + sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) + maxResults: integer, The maximum number of rows of report data to return. + filter: string, Filters to be run on the report. (repeated) + dimension: string, Dimensions to base the report on. (repeated) + +Returns: + The media object as a string. + ++
+ generate(savedReportId, locale=None, maxResults=None, startIndex=None)
Generate an AdSense report based on the saved report ID sent in the query parameters.
+
+ list(pageToken=None, maxResults=None)
List all saved reports in this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+generate(savedReportId, locale=None, maxResults=None, startIndex=None)
+ Generate an AdSense report based on the saved report ID sent in the query parameters.
+
+Args:
+ savedReportId: string, The saved report to retrieve. (required)
+ locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
+ maxResults: integer, The maximum number of rows of report data to return.
+ startIndex: integer, Index of the first row of report data to return.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#report", # Kind this is, in this case adsense#report.
+ "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
+ [
+ "A String",
+ ],
+ ],
+ "warnings": [ # Any warnings associated with generation of the report.
+ "A String",
+ ],
+ "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
+ {
+ "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
+ "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
+ "name": "A String", # The name of the header.
+ },
+ ],
+ "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
+ "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+ "A String",
+ ],
+ }
+list(pageToken=None, maxResults=None)
+ List all saved reports in this AdSense account.
+
+Args:
+ pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The saved reports returned in this list response.
+ {
+ "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
+ "id": "A String", # Unique identifier of this saved report.
+ "name": "A String", # This saved report's name.
+ },
+ ],
+ "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
Get a specific saved ad style from the user's account.
+
+ list(pageToken=None, maxResults=None)
List all saved ad styles in the user's account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(savedAdStyleId)
+ Get a specific saved ad style from the user's account.
+
+Args:
+ savedAdStyleId: string, Saved ad style to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
+ "adStyle": { # The AdStyle itself.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ "name": "A String", # The user selected name of this SavedAdStyle.
+ "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ }
+list(pageToken=None, maxResults=None)
+ List all saved ad styles in the user's account.
+
+Args:
+ pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The saved ad styles returned in this list response.
+ {
+ "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
+ "adStyle": { # The AdStyle itself.
+ "corners": "A String", # The style of the corners in the ad.
+ "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
+ "url": "A String", # The color of the ad url.
+ "text": "A String", # The color of the ad text.
+ "border": "A String", # The color of the ad border.
+ "background": "A String", # The color of the ad background.
+ "title": "A String", # The color of the ad title.
+ },
+ "font": { # The font which is included in the style.
+ "family": "A String", # The family of the font.
+ "size": "A String", # The size of the font.
+ },
+ "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
+ },
+ "name": "A String", # The user selected name of this SavedAdStyle.
+ "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ },
+ ],
+ "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ list(adClientId, pageToken=None, maxResults=None)
List all URL channels in the specified ad client for this AdSense account.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+list(adClientId, pageToken=None, maxResults=None)
+ List all URL channels in the specified ad client for this AdSense account.
+
+Args:
+ adClientId: string, Ad client for which to list URL channels. (required)
+ pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # The URL channels returned in this list response.
+ {
+ "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
+ "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+ "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
+ },
+ ],
+ "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
+ "etag": "A String", # ETag of this response for caching purposes.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
Returns Analytics data for a profile.
+Returns Analytics data for a view (profile).
get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)
- Returns Analytics data for a profile.
+ Returns Analytics data for a view (profile).
Args:
- ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
+ ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
@@ -97,7 +97,7 @@ Args:
Returns:
An object of the form:
- { # Analytics data for a given profile.
+ { # Analytics data for a given view (profile).
"kind": "analytics#gaData", # Resource type.
"rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
[
@@ -129,13 +129,13 @@ Returns:
"end-date": "A String", # End date.
},
"previousLink": "A String", # Link to previous page for this Analytics data query.
- "profileInfo": { # Information for the profile, for which the Analytics data was requested.
- "webPropertyId": "A String", # Web Property ID to which this profile belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
- "tableId": "A String", # Table ID for profile.
- "profileId": "A String", # Profile ID.
- "profileName": "A String", # Profile name.
- "accountId": "A String", # Account ID to which this profile belongs.
+ "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
+ "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
+ "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
+ "tableId": "A String", # Table ID for view (profile).
+ "profileId": "A String", # View (Profile) ID.
+ "profileName": "A String", # View (Profile) name.
+ "accountId": "A String", # Account ID to which this view (profile) belongs.
},
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
{
diff --git a/docs/dyn/analytics_v3.data.html b/docs/dyn/analytics_v3.data.html
index 909faec..7d24ed6 100644
--- a/docs/dyn/analytics_v3.data.html
+++ b/docs/dyn/analytics_v3.data.html
@@ -84,4 +84,9 @@ h1, h2, h3 {
Returns the mcf Resource.
+
+ realtime()
+
+Returns the realtime Resource.
+