+ batchGet(body, x__xgafv=None)
Returns AMP URL(s) and equivalent
+batchGet(body, x__xgafv=None)
+ Returns AMP URL(s) and equivalent
+[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # AMP URL request for a batch of URLs.
+ "lookupStrategy": "A String", # The lookup_strategy being requested.
+ "urls": [ # List of URLs to look up for the paired AMP URLs.
+ # The URLs are case-sensitive. Up to 50 URLs per lookup
+ # (see [Usage Limits](/amp/cache/reference/limits)).
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Batch AMP URL response.
+ "ampUrls": [ # For each URL in BatchAmpUrlsRequest, the URL response. The response might
+ # not be in the same order as URLs in the batch request.
+ # If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
+ # only once.
+ { # AMP URL response for a requested URL.
+ "ampUrl": "A String", # The AMP URL pointing to the publisher's web server.
+ "cdnAmpUrl": "A String", # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache.
+ "originalUrl": "A String", # The original non-AMP URL.
+ },
+ ],
+ "urlErrors": [ # The errors for requested URLs that have no AMP URL.
+ { # AMP URL Error resource for a requested URL that couldn't be found.
+ "errorCode": "A String", # The error code of an API call.
+ "errorMessage": "A String", # An optional descriptive error message.
+ "originalUrl": "A String", # The original non-AMP URL.
+ },
+ ],
+ }
+
+ ampUrls()
+
Returns the ampUrls Resource.
+ + +Create a BatchHttpRequest object based on the discovery document.
+new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
List all the deals for a given proposal Args: - proposalId: string, The proposalId to get deals for. To search across proposals specify order_id = '-' as part of the URL. (required) + proposalId: string, The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL. (required) pqlQuery: string, Query string to retrieve specific deals. Returns: @@ -729,6 +804,7 @@@@ -198,13 +206,15 @@Method Details
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) @@ -743,6 +819,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -759,21 +836,39 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, - "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity. + "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. + "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy. }, }, + "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. + "priorityPrice": { # Optional price for Rubicon priority access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + "standardPrice": { # Optional price for Rubicon standard access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + }, "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). "reservePricePerBuyers": [ # Reserve price for the specified buyer. @@ -785,6 +880,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -810,6 +906,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -841,6 +938,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -859,7 +957,7 @@Method Details
"key": "A String", # The key representing the shared targeting criterion. }, ], - "dealId": "A String", # A unique deal=id for the deal (readonly). + "dealId": "A String", # A unique deal-id for the deal (readonly). "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly) "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) @@ -877,6 +975,8 @@Method Details
"dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions) "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action) "hasSellerPaused": True or False, + "buyerPauseReason": "A String", + "sellerPauseReason": "A String", "hasBuyerPaused": True or False, "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first. }, @@ -926,6 +1026,7 @@Method Details
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) @@ -940,6 +1041,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -956,21 +1058,39 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, - "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity. + "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. + "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy. }, }, + "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. + "priorityPrice": { # Optional price for Rubicon priority access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + "standardPrice": { # Optional price for Rubicon standard access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + }, "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). "reservePricePerBuyers": [ # Reserve price for the specified buyer. @@ -982,6 +1102,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -1007,6 +1128,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -1038,6 +1160,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -1056,7 +1179,7 @@Method Details
"key": "A String", # The key representing the shared targeting criterion. }, ], - "dealId": "A String", # A unique deal=id for the deal (readonly). + "dealId": "A String", # A unique deal-id for the deal (readonly). "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly) "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) @@ -1074,6 +1197,8 @@Method Details
"dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions) "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action) "hasSellerPaused": True or False, + "buyerPauseReason": "A String", + "sellerPauseReason": "A String", "hasBuyerPaused": True or False, "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first. }, @@ -1100,7 +1225,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -1123,7 +1248,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -1135,7 +1260,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -1180,6 +1305,7 @@Method Details
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) @@ -1194,6 +1320,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -1210,21 +1337,39 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, - "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity. + "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. + "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy. }, }, + "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. + "priorityPrice": { # Optional price for Rubicon priority access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + "standardPrice": { # Optional price for Rubicon standard access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + }, "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). "reservePricePerBuyers": [ # Reserve price for the specified buyer. @@ -1236,6 +1381,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -1261,6 +1407,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -1292,6 +1439,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -1310,7 +1458,7 @@Method Details
"key": "A String", # The key representing the shared targeting criterion. }, ], - "dealId": "A String", # A unique deal=id for the deal (readonly). + "dealId": "A String", # A unique deal-id for the deal (readonly). "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly) "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) @@ -1328,6 +1476,8 @@Method Details
"dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions) "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action) "hasSellerPaused": True or False, + "buyerPauseReason": "A String", + "sellerPauseReason": "A String", "hasBuyerPaused": True or False, "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first. }, diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html b/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html index 73679b5c1da..944b79cb0f1 100644 --- a/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html +++ b/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html @@ -78,7 +78,7 @@Instance Methods
insert(proposalId, body)Add notes to the proposal
+list(proposalId, pqlQuery=None)Get all the notes associated with a proposal
Method Details
@@ -126,17 +126,18 @@Method Details
-@@ -138,13 +140,15 @@list(proposalId)+list(proposalId, pqlQuery=None)Get all the notes associated with a proposal Args: - proposalId: string, The proposalId to get notes for. (required) + proposalId: string, The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. (required) + pqlQuery: string, Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%" Returns: An object of the form: { - "notes": [ # The list of matching notes. + "notes": [ # The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first. { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create) diff --git a/docs/dyn/adexchangebuyer_v1_4.products.html b/docs/dyn/adexchangebuyer_v1_4.products.html index a793a8ec68f..e44b51bfd5b 100644 --- a/docs/dyn/adexchangebuyer_v1_4.products.html +++ b/docs/dyn/adexchangebuyer_v1_4.products.html @@ -107,8 +107,9 @@Method Details
"dimensionType": "A String", "dimensionValues": [ { # Value of the dimension. + "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. "id": 42, # Id of the dimension. - "name": "A String", # Name of the dimension mainly for debugging purposes. + "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. }, ], }, @@ -159,6 +160,7 @@Method Details
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) @@ -173,6 +175,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -189,21 +192,39 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, - "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity. + "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. + "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy. }, }, + "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. + "priorityPrice": { # Optional price for Rubicon priority access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + "standardPrice": { # Optional price for Rubicon standard access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + }, "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). "reservePricePerBuyers": [ # Reserve price for the specified buyer. @@ -215,6 +236,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -241,6 +263,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -272,6 +295,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -328,8 +352,9 @@Method Details
"dimensionType": "A String", "dimensionValues": [ { # Value of the dimension. + "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. "id": 42, # Id of the dimension. - "name": "A String", # Name of the dimension mainly for debugging purposes. + "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. }, ], }, @@ -380,6 +405,7 @@Method Details
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) @@ -394,6 +420,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -410,21 +437,39 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, - "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity. + "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. + "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy. }, }, + "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. + "priorityPrice": { # Optional price for Rubicon priority access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + "standardPrice": { # Optional price for Rubicon standard access in the auction. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. + "amountMicros": 3.14, # The price value in micros. + }, + }, "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). "reservePricePerBuyers": [ # Reserve price for the specified buyer. @@ -436,6 +481,7 @@Method Details
"price": { # The specified price "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. + "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. "amountMicros": 3.14, # The price value in micros. }, }, @@ -462,6 +508,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { @@ -493,6 +540,7 @@Method Details
"timeZoneType": "A String", }, "creativeSizeValue": { # The creative size value to exclude/include. + "skippableAdType": "A String", # The skippable ad type for video size. "creativeSizeType": "A String", # The Creative size type. "companionSizes": [ # For video size type, the list of companion sizes. { diff --git a/docs/dyn/adexchangebuyer_v1_4.proposals.html b/docs/dyn/adexchangebuyer_v1_4.proposals.html index 974d218329f..bc99406d3a5 100644 --- a/docs/dyn/adexchangebuyer_v1_4.proposals.html +++ b/docs/dyn/adexchangebuyer_v1_4.proposals.html @@ -122,7 +122,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -145,7 +145,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -157,7 +157,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -196,7 +196,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -219,7 +219,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -231,7 +231,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -266,7 +266,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -289,7 +289,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -301,7 +301,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -348,7 +348,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -371,7 +371,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -383,7 +383,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -414,7 +414,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -437,7 +437,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -449,7 +449,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -489,7 +489,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -512,7 +512,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -524,7 +524,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -580,7 +580,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -603,7 +603,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -615,7 +615,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -646,7 +646,7 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). + "sellerContacts": [ # Optional contact information of the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. @@ -669,7 +669,7 @@Method Details
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". "proposalState": "A String", # The current state of the proposal. (readonly) "name": "A String", # The name for the proposal (updatable) @@ -681,7 +681,7 @@Method Details
"accountId": "A String", # Adx account id of the buyer. }, "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) - "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) + "buyerContacts": [ # Optional contact information of the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. diff --git a/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html b/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html index e4271c07deb..c197c25345c 100644 --- a/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html +++ b/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html @@ -100,8 +100,9 @@Method Details
"dimensionType": "A String", "dimensionValues": [ { # Value of the dimension. + "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. "id": 42, # Id of the dimension. - "name": "A String", # Name of the dimension mainly for debugging purposes. + "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. }, ], }, diff --git a/docs/dyn/analytics_v3.management.html b/docs/dyn/analytics_v3.management.html index 76936bbfe41..10e5f9adadb 100644 --- a/docs/dyn/analytics_v3.management.html +++ b/docs/dyn/analytics_v3.management.html @@ -134,6 +134,11 @@Instance Methods
Returns the profiles Resource.
+ +Returns the remarketingAudience Resource.
+ diff --git a/docs/dyn/analytics_v3.management.remarketingAudience.html b/docs/dyn/analytics_v3.management.remarketingAudience.html new file mode 100644 index 00000000000..94a19f5da56 --- /dev/null +++ b/docs/dyn/analytics_v3.management.remarketingAudience.html @@ -0,0 +1,595 @@ + + + +Google Analytics API . management . remarketingAudience
+Instance Methods
++
+get(accountId, webPropertyId, remarketingAudienceId)Gets remarketing audiences to which the user has access.
++
+insert(accountId, webPropertyId, body)Creates a new remarketing audiences.
++
+list(accountId, webPropertyId, max_results=None, type=None, start_index=None)Lists remarketing audiences to which the user has access.
++
+patch(accountId, webPropertyId, remarketingAudienceId, body)Updates an existing remarketing audiences. This method supports patch semantics.
++
+update(accountId, webPropertyId, remarketingAudienceId, body)Updates an existing remarketing audiences.
+Method Details
+++ +get(accountId, webPropertyId, remarketingAudienceId)+Gets remarketing audiences to which the user has access. + +Args: + accountId: string, Account ID for the remarketing audience to retrieve. (required) + webPropertyId: string, Web property ID for the remarketing audience to retrieve. (required) + remarketingAudienceId: string, The ID to retrieve the Remarketing Audience for. (required) + +Returns: + An object of the form: + + { # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + }+++ +insert(accountId, webPropertyId, body)+Creates a new remarketing audiences. + +Args: + accountId: string, Account ID to create the remarketing audience for. (required) + webPropertyId: string, Web property ID to create the remarketing audience for. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + } + + +Returns: + An object of the form: + + { # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + }+++ +list(accountId, webPropertyId, max_results=None, type=None, start_index=None)+Lists remarketing audiences to which the user has access. + +Args: + accountId: string, Account ID for the remarketing audience to retrieve. (required) + webPropertyId: string, Web property ID for the remarketing audience to retrieve. (required) + max_results: integer, The maximum number of remarketing audiences to include in this response. + type: string, A parameter + start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. + +Returns: + An object of the form: + + { # A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience. + "username": "A String", # Email ID of the authenticated user + "kind": "analytics#remarketingAudiences", # Collection type. + "items": [ # A list of remarketing audiences. + { # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + }, + ], + "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. + "previousLink": "A String", # Link to previous page for this view (profile) collection. + "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. + "nextLink": "A String", # Link to next page for this remarketing audience collection. + "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. + }+++ +patch(accountId, webPropertyId, remarketingAudienceId, body)+Updates an existing remarketing audiences. This method supports patch semantics. + +Args: + accountId: string, Account ID for the remarketing audience to update. (required) + webPropertyId: string, Web property ID for the remarketing audience to update. (required) + remarketingAudienceId: string, Remarketing audience ID of the remarketing audience to update. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + } + + +Returns: + An object of the form: + + { # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + }+++ + \ No newline at end of file diff --git a/docs/dyn/analytics_v3.management.unsampledReports.html b/docs/dyn/analytics_v3.management.unsampledReports.html index 186103f255b..6af6d842353 100644 --- a/docs/dyn/analytics_v3.management.unsampledReports.html +++ b/docs/dyn/analytics_v3.management.unsampledReports.html @@ -119,7 +119,7 @@update(accountId, webPropertyId, remarketingAudienceId, body)+Updates an existing remarketing audiences. + +Args: + accountId: string, Account ID for the remarketing audience to update. (required) + webPropertyId: string, Web property ID for the remarketing audience to update. (required) + remarketingAudienceId: string, Remarketing audience ID of the remarketing audience to update. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + } + + +Returns: + An object of the form: + + { # JSON template for an Analytics remarketing audience. + "linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. + { # JSON template for an Analytics Remarketing Audience Foreign Link. + "linkedAccountId": "A String", # The foreign account ID. For example the an AdWords `linkedAccountId` has the following format XXX-XXX-XXXX. + "status": "A String", # The status of this foreign account link. + "kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account. + "remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs. + "eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. + "type": "A String", # The type of the foreign account. For example `ADWORDS_LINKS`. + "id": "A String", # Entity ad account link ID. + "accountId": "A String", # Account ID to which this linked foreign account belongs. + }, + ], + "kind": "analytics#remarketingAudience", # Collection type. + "description": "A String", # The description of this remarketing audience. + "created": "A String", # Time this remarketing audience was created. + "updated": "A String", # Time this remarketing audience was last modified. + "name": "A String", # The name of this remarketing audience. + "internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs. + "linkedViews": [ # The views (profiles) that this remarketing audience is linked to. + "A String", + ], + "stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + "excludeConditions": { # Defines the conditions to exclude users from the audience. + "segment": "A String", # The segment condition that will cause a user to be removed from an audience. + "exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT. + }, + }, + "audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED. + "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. + "accountId": "A String", # Account ID to which this remarketing audience belongs. + "id": "A String", # Remarketing Audience ID. + "audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience. + "includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience. + "daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. + "segment": "A String", # The segment condition that will cause a user to be added to an audience. + "kind": "analytics#includeConditions", # Resource type for include conditions. + "isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 + "membershipDurationDays": 42, # Number of days a user remains in the audience. Use any integer from 1-540. In remarketing audiences for search ads, membership duration is truncated to 180 days. + }, + }, + }+Method Details
"bucketId": "A String", # Id of the bucket the file object is stored in. "objectId": "A String", # Id of the file object containing the report data. }, - "downloadType": "A String", # The type of download you need to use for the report data file. + "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. "dimensions": "A String", # The dimensions for the unsampled report. "created": "A String", # Time this unsampled report was created. "segment": "A String", # The segment for the unsampled report. @@ -158,7 +158,7 @@Method Details
"bucketId": "A String", # Id of the bucket the file object is stored in. "objectId": "A String", # Id of the file object containing the report data. }, - "downloadType": "A String", # The type of download you need to use for the report data file. + "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. "dimensions": "A String", # The dimensions for the unsampled report. "created": "A String", # Time this unsampled report was created. "segment": "A String", # The segment for the unsampled report. @@ -189,7 +189,7 @@Method Details
"bucketId": "A String", # Id of the bucket the file object is stored in. "objectId": "A String", # Id of the file object containing the report data. }, - "downloadType": "A String", # The type of download you need to use for the report data file. + "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. "dimensions": "A String", # The dimensions for the unsampled report. "created": "A String", # Time this unsampled report was created. "segment": "A String", # The segment for the unsampled report. @@ -235,7 +235,7 @@Method Details
"bucketId": "A String", # Id of the bucket the file object is stored in. "objectId": "A String", # Id of the file object containing the report data. }, - "downloadType": "A String", # The type of download you need to use for the report data file. + "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. "dimensions": "A String", # The dimensions for the unsampled report. "created": "A String", # Time this unsampled report was created. "segment": "A String", # The segment for the unsampled report. diff --git a/docs/dyn/analyticsreporting_v4.reports.html b/docs/dyn/analyticsreporting_v4.reports.html index 780479c708e..f4316beca02 100644 --- a/docs/dyn/analyticsreporting_v4.reports.html +++ b/docs/dyn/analyticsreporting_v4.reports.html @@ -89,14 +89,17 @@Method Details
{ # The batch request containing multiple report request. "reportRequests": [ # Requests, each request will have a separate response. # There can be a maximum of 5 requests. All requests should have the same - # `dateRange`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. + # `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. { # The main request class which specifies the Reporting API request. - "pivots": [ # The pivot definitions. + "pivots": [ # The pivot definitions. Requests can have a maximum of 2 pivots. { # The Pivot describes the pivot section in the request. # The Pivot helps rearrange the information in the table for certain reports # by pivoting your data on a second dimension. - "metrics": [ # Metrics to aggregate and return. - { # A metric in the request. + "metrics": [ # The pivot metrics. Pivot metrics are part of the + # restriction on total number of metrics allowed in the request. + { # [Metrics](https://support.google.com/analytics/answer/1033861) + # are the quantitative measurements. For example, the metric `ga:users` + # indicates the total number of users for the requested time period. "alias": "A String", # An alias for the metric expression is an alternate name for the # expression. The alias can be used for filtering and sorting. This field # is optional and is useful if the expression is not a single metric but @@ -127,8 +130,13 @@Method Details
# # The following let you choose which of the groups of k columns are # included in the response. - "dimensions": [ # A list of dimensions to show as pivot columns. - { # A dimension in the request. + "dimensions": [ # A list of dimensions to show as pivot columns. A Pivot can have a maximum + # of 4 dimensions. Pivot dimensions are part of the restriction on the + # total number of dimensions allowed in the request. + { # [Dimensions](https://support.google.com/analytics/answer/1033861) + # are attributes of your data. For example, the dimension `ga:city` + # indicates the city, for example, "Paris" or "New York", from which + # a session originates. "name": "A String", # Name of the dimension to fetch, for example `ga:browser`. "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to # int64. Dimension values that are not the string representation of an @@ -200,9 +208,12 @@Method Details
], "hideTotals": True or False, # If set to true, hides the total of all metrics for all the matching rows, # for every date range. The default false and will return the totals. - "metrics": [ # Metrics, the quantitative measurements, requested in the request. - # Requests must specify at least one metric. - { # A metric in the request. + "metrics": [ # The metrics requested. + # Requests must specify at least one metric. Requests can have a + # total of 10 metrics. + { # [Metrics](https://support.google.com/analytics/answer/1033861) + # are the quantitative measurements. For example, the metric `ga:users` + # indicates the total number of users for the requested time period. "alias": "A String", # An alias for the metric expression is an alternate name for the # expression. The alias can be used for filtering and sorting. This field # is optional and is useful if the expression is not a single metric but @@ -220,8 +231,12 @@Method Details
# `INTEGER`. }, ], - "dimensions": [ # Dimensions requested in the request. - { # A dimension in the request. + "dimensions": [ # The dimensions requested. + # Requests can have a total of 7 dimensions. + { # [Dimensions](https://support.google.com/analytics/answer/1033861) + # are attributes of your data. For example, the dimension `ga:city` + # indicates the city, for example, "Paris" or "New York", from which + # a session originates. "name": "A String", # Name of the dimension to fetch, for example `ga:browser`. "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to # int64. Dimension values that are not the string representation of an @@ -296,7 +311,8 @@Method Details
# [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). "segments": [ # Segment the data returned for the request. A segment definition helps look # at a subset of the segment request. A request can contain up to four - # segments. All requests should have the same segment definitions. Requests + # segments. Every [ReportRequest](#ReportRequest) within a + # `batchGet` method must contain the same `segments` definition. Requests # with segments must have the `ga:segment` dimension. { # The segment definition, if the report needs to be segmented. # A Segment is a subset of the Analytics data. For example, of the entire @@ -559,8 +575,9 @@Method Details
}, ], "cohortGroup": { # Defines a cohort group. # Cohort group associated with this request. If there is a cohort group - # in the request the `ga:cohort` dimension must be present. All requests - # should have the same cohort definitions. + # in the request the `ga:cohort` dimension must be present. + # Every [ReportRequest](#ReportRequest) within a `batchGet` method must + # contain the same `cohortGroup` definition. # For example: # # "cohortGroup": { @@ -639,7 +656,9 @@Method Details
# The `reportRequest.dateRanges` field should not be specified for cohorts # or Lifetime value requests. # If a date range is not provided, the default date range is (startDate: - # current date - 7 days, endDate: current date - 1 day) + # current date - 7 days, endDate: current date - 1 day). Every + # [ReportRequest](#ReportRequest) within a `batchGet` method must + # contain the same `dateRanges` definition. { # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. # The start and end dates are specified in # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. @@ -651,9 +670,13 @@Method Details
# the request will return the rows after the pageToken. The pageToken should # be the value returned in the nextPageToken parameter in the response to # the GetReports request. - "samplingLevel": "A String", # The desired sampling level. If the sampling level is not specified the - # DEFAULT sampling level will be used. All requests should have same - # `samplingLevel`. + "samplingLevel": "A String", # The desired report + # [sample](https://support.google.com/analytics/answer/2637192) size. + # If the the `samplingLevel` field is unspecified the `DEFAULT` sampling + # level is used. Every [ReportRequest](#ReportRequest) within a + # `batchGet` method must contain the same `samplingLevel` definition. See + # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) + # for details. "pageSize": 42, # Page size is for paging and specifies the maximum number of returned rows. # Page size should be >= 0. A query returns the default of 1,000 rows. # The Analytics Core Reporting API returns a maximum of 10,000 rows per @@ -687,7 +710,10 @@Method Details
], }, ], - "viewId": "A String", # Unique View Id for retrieving Analytics data. + "viewId": "A String", # The Analytics + # [view ID](https://support.google.com/analytics/answer/1009618) + # from which to retrieve data. Every [ReportRequest](#ReportRequest) + # within a `batchGet` method must contain the same `viewId`. }, ], } @@ -708,7 +734,7 @@Method Details
"data": { # The data part of the report. # Response data. "rows": [ # There's one ReportRow for every unique combination of dimensions. { # A row in the report. - "metrics": [ # List of metrics for each requested DateRange + "metrics": [ # List of metrics for each requested DateRange. { # Used to return a list of metrics for a single DateRange / dimension # combination "values": [ # Each value corresponds to each Metric in the request. @@ -765,8 +791,13 @@Method Details
"isDataGolden": True or False, # Indicates if response to this request is golden or not. Data is # golden when the exact same request will not produce any new results if # asked at a later point in time. - "samplingSpaceSizes": [ # If sampling was enabled, this returns the total number of samples - # present, one entry per date range. + "samplingSpaceSizes": [ # If the results are + # [sampled](https://support.google.com/analytics/answer/2637192), + # this returns the total number of + # samples present, one entry per date range. If the results are not sampled + # this field will not be defined. See + # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) + # for details. "A String", ], "totals": [ # For each requested date range, for the set of all rows that match @@ -792,8 +823,12 @@Method Details
}, ], "rowCount": 42, # Total number of matching rows for this query. - "samplesReadCounts": [ # If sampling was enabled, this returns the total number of samples - # read, one entry per date range + "samplesReadCounts": [ # If the results are + # [sampled](https://support.google.com/analytics/answer/2637192), + # this returns the total number of samples read, one entry per date range. + # If the results are not sampled this field will not be defined. See + # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) + # for details. "A String", ], }, @@ -811,8 +846,7 @@Method Details
"dimensionValues": [ # The values for the dimensions in the pivot. "A String", ], - "dimensionNames": [ # The name of the dimensions in the pivotDimensionValues field in the - # response. + "dimensionNames": [ # The name of the dimensions in the pivot response. "A String", ], "metric": { # Header for the metrics. # The metric header for the metric in the pivot. diff --git a/docs/dyn/androidenterprise_v1.collectionviewers.html b/docs/dyn/androidenterprise_v1.collectionviewers.html index 94439b1eedb..908f915ee73 100644 --- a/docs/dyn/androidenterprise_v1.collectionviewers.html +++ b/docs/dyn/androidenterprise_v1.collectionviewers.html @@ -113,13 +113,15 @@Method Details
Returns: An object of the form: - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }Method Details
{ # The user resources for the collection. "kind": "androidenterprise#collectionViewersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse". "user": [ # A user of an enterprise. - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }, ], @@ -162,13 +166,15 @@Method Details
body: object, The request body. (required) The object takes the form of: -{ # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. +{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. } @@ -176,13 +182,15 @@Method Details
Returns: An object of the form: - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }
Retrieves the details of a device.
getState(enterpriseId, userId, deviceId)
Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
+Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
Retrieves the IDs of all of a user's devices.
setState(enterpriseId, userId, deviceId, body)
Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
+Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
get(enterpriseId, userId, deviceId)
@@ -103,14 +103,19 @@ getState(enterpriseId, userId, deviceId)
- Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. +Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -143,7 +148,12 @@Method Details
# # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed. "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". - "managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device + "managementType": "A String", # Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations. + # Possible values include: + # - "managedDevice"—A device that has the EMM's device policy controller (DPC) as the device owner. + # - "managedProfile"—A device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. + # - "containerApp"—A device running the Android for Work App. The Android for Work App is managed by the DPC. + # - "unmanagedProfile"—A device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0". }, ], @@ -153,7 +163,7 @@Method Details
setState(enterpriseId, userId, deviceId, body)-Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. +Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users. Args: enterpriseId: string, The ID of the enterprise. (required) diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index 70930bd5ece..6961ee8cf1a 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -74,24 +74,39 @@Google Play EMM API . enterprises
Instance Methods
++
+acknowledgeNotificationSet(notificationSetId=None)Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
++
+completeSignup(completionToken=None, enterpriseToken=None)Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.
Enrolls an enterprise with the calling EMM.
++
+generateSignupUrl(callbackUrl=None)Generates a sign-up URL.
Retrieves the name and domain of an enterprise.
++
+getServiceAccount(enterpriseId, keyType=None)Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.
-Returns the store layout resource.
+Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error.
Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.
-Looks up an enterprise by domain name.
+Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.
++
+pullNotificationSet(requestMode=None)Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.
sendTestPushNotification(enterpriseId)Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
@@ -100,11 +115,46 @@Instance Methods
Set the account that will be used to authenticate to the API as the enterprise.
-
setStoreLayout(enterpriseId, body)Sets the store layout resource.
+Sets the store layout for the enterprise.
Unenrolls an enterprise from the calling EMM.
Method Details
+++ +acknowledgeNotificationSet(notificationSetId=None)+Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. + +Args: + notificationSetId: string, The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided. ++++completeSignup(completionToken=None, enterpriseToken=None)+Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. + +Args: + completionToken: string, The Completion token initially returned by GenerateSignupUrl. + enterpriseToken: string, The Enterprise token appended to the Callback URL. + +Returns: + An object of the form: + + { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". + "id": "A String", # The unique ID for the enterprise. + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". + }++delete(enterpriseId)Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call. @@ -123,41 +173,57 @@Method Details
body: object, The request body. (required) The object takes the form of: -{ # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". +{ # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". } Returns: An object of the form: - { # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". + { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". }++generateSignupUrl(callbackUrl=None)+Generates a sign-up URL. + +Args: + callbackUrl: string, The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. +Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. + +Returns: + An object of the form: + + { # A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token. + "url": "A String", # A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe. + "kind": "androidenterprise#signupInfo", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo". + "completionToken": "A String", # An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup. + }++get(enterpriseId)Retrieves the name and domain of an enterprise. @@ -168,25 +234,56 @@Method Details
Returns: An object of the form: - { # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". + { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". }++getServiceAccount(enterpriseId, keyType=None)+Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. + +This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. + +Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. + +Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + keyType: string, The type of credential to return with the service account. Required. + Allowed values + googleCredentials - + pkcs12 - + +Returns: + An object of the form: + + { # A service account identity, including the name and credentials that can be used to authenticate as the service account. + "kind": "androidenterprise#serviceAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount". + "name": "A String", # The account name of the service account, in the form of an email address. Assigned by the server. + "key": { # Credentials that can be used to authenticate as a service account. # Credentials that can be used to authenticate as this ServiceAccount. + "type": "A String", # The file format of the generated key data. + "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". + "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. + "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. + }, + }+getStoreLayout(enterpriseId)-Returns the store layout resource. +Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -197,7 +294,7 @@Method Details
{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened. "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store. # - # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store. + # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store. # # If there exists at least one page, this field must be set to the ID of a valid page. "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". @@ -213,44 +310,42 @@Method Details
body: object, The request body. (required) The object takes the form of: -{ # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". +{ # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". } Returns: An object of the form: - { # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". + { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". }+ +list(domain)-Looks up an enterprise by domain name. +Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call. Args: domain: string, The exact primary domain name of the enterprise to look up. (required) @@ -261,21 +356,79 @@+Method Details
{ # The matching enterprise resources. "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse". "enterprise": [ # An enterprise. - { # An enterprise resource represents a binding between an organization and their EMM. - # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise. - # - # After calling enroll the EMM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). - # - # The EMM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. - # - # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method. - "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com". + { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: + # - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. + # - For Android for Work Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the Android for Work Sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details. + "administrator": [ # Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. + { # This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store. + "email": "A String", # The administrator's email address. + }, + ], + "primaryDomain": "A String", # The enterprise's primary domain, such as "example.com". "id": "A String", # The unique ID for the enterprise. - "name": "A String", # The name of the enterprise, e.g. "Example Inc". + "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". + "name": "A String", # The name of the enterprise, for example, "Example, Inc". + }, + ], + }+@@ -321,7 +474,7 @@pullNotificationSet(requestMode=None)+Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. +A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. +Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. +Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. + +Args: + requestMode: string, The request mode for pulling notifications. If omitted, defaults to WAIT_FOR_NOTIFCATIONS. +If this is set to WAIT_FOR_NOTIFCATIONS, the request will eventually timeout, in which case it should be retried. + Allowed values + returnImmediately - + waitForNotifications - + +Returns: + An object of the form: + + { # A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request. + "notification": [ # The notifications received, or empty if no notifications are present. + { # A notification of one event relating to an enterprise. + "appRestrictionsSchemaChangeEvent": { # An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API. # Notifications about new app restrictions schema changes. + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present. + }, + "newPermissionsEvent": { # An event generated when new permissions are added to an app. # Notifications about new app permissions. + "approvedPermissions": [ # The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions. + "A String", + ], + "requestedPermissions": [ # The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions. + "A String", + ], + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present. + }, + "productAvailabilityChangeEvent": { # An event generated whenever a product's availability changes. # Notifications about product availability changes. + "availabilityStatus": "A String", # The new state of the product. This field will always be present. + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present. + }, + "productApprovalEvent": { # An event generated when a product's approval status is changed. # Notifications about changes to a product's approval status. + "approved": "A String", # Whether the product was approved or unapproved. This field will always be present. + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present. + }, + "enterpriseId": "A String", # The ID of the enterprise for which the notification is sent. This will always be present. + "installFailureEvent": { # An event generated when an app installation failed on a device # Notifications about an app installation failure. + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present. + "userId": "A String", # The ID of the user. This field will always be present. + "deviceId": "A String", # The Android ID of the device. This field will always be present. + "failureDetails": "A String", # Additional details on the failure if applicable. + "failureReason": "A String", # The reason for the installation failure. This field will always be present. + }, + "appUpdateEvent": { # An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. # Notifications about app updates. + "productId": "A String", # The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present. }, + "timestampMillis": "A String", # The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present. + }, ], + "kind": "androidenterprise#notificationSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet". + "notificationSetId": "A String", # The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present. }Method Details
setStoreLayout(enterpriseId, body)-Sets the store layout resource. +Sets the store layout for the enterprise. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -331,7 +484,7 @@Method Details
{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened. "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store. # - # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store. + # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store. # # If there exists at least one page, this field must be set to the ID of a valid page. "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". @@ -344,7 +497,7 @@Method Details
{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened. "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store. # - # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store. + # If a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store. # # If there exists at least one page, this field must be set to the ID of a valid page. "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". diff --git a/docs/dyn/androidenterprise_v1.grouplicenseusers.html b/docs/dyn/androidenterprise_v1.grouplicenseusers.html index 7f19d6c4a13..5b342f11621 100644 --- a/docs/dyn/androidenterprise_v1.grouplicenseusers.html +++ b/docs/dyn/androidenterprise_v1.grouplicenseusers.html @@ -92,13 +92,15 @@Method Details
{ # The user resources for the group license. "kind": "androidenterprise#groupLicenseUsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicenseUsersListResponse". "user": [ # A user of an enterprise. - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }, ], diff --git a/docs/dyn/androidenterprise_v1.html b/docs/dyn/androidenterprise_v1.html index 2d533ca255c..b52862d5a6c 100644 --- a/docs/dyn/androidenterprise_v1.html +++ b/docs/dyn/androidenterprise_v1.html @@ -114,6 +114,16 @@Instance Methods
Returns the installs Resource.
++
+managedconfigurationsfordevice()+Returns the managedconfigurationsfordevice Resource.
+ ++
+managedconfigurationsforuser()+Returns the managedconfigurationsforuser Resource.
+ @@ -124,6 +134,11 @@Instance Methods
Returns the products Resource.
+ +Returns the serviceaccountkeys Resource.
+ diff --git a/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html b/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html new file mode 100644 index 00000000000..875ce0616e8 --- /dev/null +++ b/docs/dyn/androidenterprise_v1.managedconfigurationsfordevice.html @@ -0,0 +1,339 @@ + + + +Google Play EMM API . managedconfigurationsfordevice
+Instance Methods
++
+delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)Removes a per-device managed configuration for an app for the specified device.
++
+get(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)Retrieves details of a per-device managed configuration.
++
+list(enterpriseId, userId, deviceId)Lists all the per-device managed configurations for the specified device. Only the ID is set.
++
+patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.
++
+update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)Adds or updates a per-device managed configuration for an app for the specified device.
+Method Details
+++ +delete(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)+Removes a per-device managed configuration for an app for the specified device. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + deviceId: string, The Android ID of the device. (required) + managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) ++++ +get(enterpriseId, userId, deviceId, managedConfigurationForDeviceId)+Retrieves details of a per-device managed configuration. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + deviceId: string, The Android ID of the device. (required) + managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+++ +list(enterpriseId, userId, deviceId)+Lists all the per-device managed configurations for the specified device. Only the ID is set. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + deviceId: string, The Android ID of the device. (required) + +Returns: + An object of the form: + + { # The managed configuration resources for the device. + "kind": "androidenterprise#managedConfigurationsForDeviceListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForDeviceListResponse". + "managedConfigurationForDevice": [ # A managed configuration for an app on a specific device. + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }, + ], + }+++ +patch(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)+Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + deviceId: string, The Android ID of the device. (required) + managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + } + + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+++ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html b/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html new file mode 100644 index 00000000000..532ca2293b7 --- /dev/null +++ b/docs/dyn/androidenterprise_v1.managedconfigurationsforuser.html @@ -0,0 +1,334 @@ + + + +update(enterpriseId, userId, deviceId, managedConfigurationForDeviceId, body)+Adds or updates a per-device managed configuration for an app for the specified device. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + deviceId: string, The Android ID of the device. (required) + managedConfigurationForDeviceId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + } + + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+Google Play EMM API . managedconfigurationsforuser
+Instance Methods
++
+delete(enterpriseId, userId, managedConfigurationForUserId)Removes a per-user managed configuration for an app for the specified user.
++
+get(enterpriseId, userId, managedConfigurationForUserId)Retrieves details of a per-user managed configuration for an app for the specified user.
+ +Lists all the per-user managed configurations for the specified user. Only the ID is set.
++
+patch(enterpriseId, userId, managedConfigurationForUserId, body)Adds or updates a per-user managed configuration for an app for the specified user. This method supports patch semantics.
++
+update(enterpriseId, userId, managedConfigurationForUserId, body)Adds or updates a per-user managed configuration for an app for the specified user.
+Method Details
+++ +delete(enterpriseId, userId, managedConfigurationForUserId)+Removes a per-user managed configuration for an app for the specified user. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) ++++ +get(enterpriseId, userId, managedConfigurationForUserId)+Retrieves details of a per-user managed configuration for an app for the specified user. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+++ +list(enterpriseId, userId)+Lists all the per-user managed configurations for the specified user. Only the ID is set. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + +Returns: + An object of the form: + + { # The managed configuration resources for the user. + "kind": "androidenterprise#managedConfigurationsForUserListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse". + "managedConfigurationForUser": [ # A managed configuration for an app for a specific user. + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }, + ], + }+++ +patch(enterpriseId, userId, managedConfigurationForUserId, body)+Adds or updates a per-user managed configuration for an app for the specified user. This method supports patch semantics. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + } + + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+++ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html index a7ac162d6c9..f1a3d174679 100644 --- a/docs/dyn/androidenterprise_v1.products.html +++ b/docs/dyn/androidenterprise_v1.products.html @@ -85,13 +85,16 @@update(enterpriseId, userId, managedConfigurationForUserId, body)+Adds or updates a per-user managed configuration for an app for the specified user. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + } + + +Returns: + An object of the form: + + { # A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema. + "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". + "managedProperty": [ # The set of managed properties for this configuration. + { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema. + "key": "A String", # The unique key that identifies the property. + "valueInteger": 42, # The integer value - this will only be present if type of the property is integer. + "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect. + "A String", + ], + "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool. + "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array. + { # A bundle of managed properties. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + ], + "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle. + "managedProperty": [ # The list of managed properties. + # Object with schema name: ManagedProperty + ], + }, + "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden. + }, + ], + "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm". + }+Instance Methods
Retrieves details of a product for display to an enterprise admin.
-
getAppRestrictionsSchema(enterpriseId, productId, language=None)Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined.
+Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an administrator to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.
getPermissions(enterpriseId, productId)Retrieves the Android app permissions required by this app.
-
list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None)Finds approved products that match a query.
+Finds approved products that match a query, or all approved products if there is no query.
++
+unapprove(enterpriseId, productId)Unapproves the specified product (and the relevant app permissions, if any)
updatePermissions(enterpriseId, productId, body)This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.
@@ -149,7 +152,7 @@Method Details
Returns: An object of the form: - { # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) + { # A Products resource represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) # # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface. "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px. @@ -163,7 +166,7 @@Method Details
"versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). }, ], - "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. + "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it). "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. "authorName": "A String", # The name of the author of the product (e.g. the app developer). "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app. @@ -174,7 +177,7 @@Method Details
getAppRestrictionsSchema(enterpriseId, productId, language=None)-Retrieves the schema defining app restrictions configurable for this product. All products have a schema, but this may be empty if no app restrictions are defined. +Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an administrator to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -187,7 +190,7 @@Method Details
{ # Represents the list of app restrictions available to be pre-configured for the product. "restrictions": [ # The set of restrictions that make up this schema. { # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied. - "restrictionType": "A String", # The type of the restriction. + "description": "A String", # A longer description of the restriction, giving more detail of what it affects. "title": "A String", # The name of the restriction. "defaultValue": { # A typed value for the restriction. # The default value of the restriction. "valueBool": True or False, # The boolean value - this will only be present if type is bool. @@ -198,6 +201,9 @@Method Details
], "valueInteger": 42, # The integer value - this will only be present if type is integer. }, + "nestedRestriction": [ # For bundle or bundleArray restrictions, the list of nested restrictions. + # Object with schema name: AppRestrictionsSchemaRestriction + ], "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values. "A String", ], @@ -205,7 +211,7 @@Method Details
"entry": [ # For choice or multiselect restrictions, the list of possible entries' human-readable names. "A String", ], - "description": "A String", # A longer description of the restriction, giving more detail of what it affects. + "restrictionType": "A String", # The type of the restriction. }, ], "kind": "androidenterprise#appRestrictionsSchema", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema". @@ -239,14 +245,14 @@Method Details
+list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None)-Finds approved products that match a query. +Finds approved products that match a query, or all approved products if there is no query. Args: enterpriseId: string, The ID of the enterprise. (required) language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language. maxResults: integer, Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response. token: string, A pagination token is contained in a requestÂ’s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request. - query: string, The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters). + query: string, The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps). approved: boolean, Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified. Returns: @@ -254,7 +260,7 @@Method Details
{ # The matching products. "product": [ # Information about a product (e.g. an app) in the Google Play Store, for display to an enterprise admin. - { # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) + { # A Products resource represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) # # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface. "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px. @@ -268,7 +274,7 @@Method Details
"versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). }, ], - "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. + "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it). "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. "authorName": "A String", # The name of the author of the product (e.g. the app developer). "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app. @@ -289,6 +295,16 @@Method Details
}++unapprove(enterpriseId, productId)+Unapproves the specified product (and the relevant app permissions, if any) + +Args: + enterpriseId: string, The ID of the enterprise. (required) + productId: string, The ID of the product. (required) +++updatePermissions(enterpriseId, productId, body)This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements. diff --git a/docs/dyn/androidenterprise_v1.serviceaccountkeys.html b/docs/dyn/androidenterprise_v1.serviceaccountkeys.html new file mode 100644 index 00000000000..438225f963b --- /dev/null +++ b/docs/dyn/androidenterprise_v1.serviceaccountkeys.html @@ -0,0 +1,149 @@ + + + +Google Play EMM API . serviceaccountkeys
+Instance Methods
+ +Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
+ +Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
+ +Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
+Method Details
+++ +delete(enterpriseId, keyId)+Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + keyId: string, The ID of the key. (required) ++++ +insert(enterpriseId, body)+Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. + +Only the type of the key should be populated in the resource to be inserted. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # Credentials that can be used to authenticate as a service account. + "type": "A String", # The file format of the generated key data. + "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". + "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. + "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. +} + + +Returns: + An object of the form: + + { # Credentials that can be used to authenticate as a service account. + "type": "A String", # The file format of the generated key data. + "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". + "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. + "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. + }+++ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html index 45fafdaddd5..493ee4d0df0 100644 --- a/docs/dyn/androidenterprise_v1.users.html +++ b/docs/dyn/androidenterprise_v1.users.html @@ -74,6 +74,12 @@list(enterpriseId)+Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + +Returns: + An object of the form: + + { + "serviceAccountKey": [ # The service account credentials. + { # Credentials that can be used to authenticate as a service account. + "type": "A String", # The file format of the generated key data. + "kind": "androidenterprise#serviceAccountKey", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". + "data": "A String", # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google. + "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. + }, + ], + }+Google Play EMM API . users
Instance Methods
++
+delete(enterpriseId, userId)Deleted an EMM-managed user.
++
+generateAuthenticationToken(enterpriseId, userId)Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.
generateToken(enterpriseId, userId)Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.
@@ -83,16 +89,54 @@Instance Methods
getAvailableProductSet(enterpriseId, userId)Retrieves the set of products a user is entitled to access.
+ +Creates a new EMM-managed user.
-Looks up a user by their primary email address.
+Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
++
+patch(enterpriseId, userId, body)Updates the details of an EMM-managed user.
revokeToken(enterpriseId, userId)Revokes a previously generated token (activation code) for the user.
setAvailableProductSet(enterpriseId, userId, body)Modifies the set of products a user is entitled to access.
++
+update(enterpriseId, userId, body)Updates the details of an EMM-managed user.
Method Details
+++ +delete(enterpriseId, userId)+Deleted an EMM-managed user. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) ++++generateAuthenticationToken(enterpriseId, userId)+Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. + +This call only works with EMM-managed accounts. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + +Returns: + An object of the form: + + { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device. + "kind": "androidenterprise#authenticationToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken". + "token": "A String", # The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated. + }+@@ -154,9 +200,49 @@generateToken(enterpriseId, userId)Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token. @@ -124,13 +168,15 @@Method Details
Returns: An object of the form: - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }Method Details
}++insert(enterpriseId, body)+Creates a new EMM-managed user. + +The Users resource passed in the body of the request should include an accountIdentifier and an accountType. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + } + + +Returns: + An object of the form: + + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + }++list(enterpriseId, email)-Looks up a user by their primary email address. +Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -168,19 +254,62 @@Method Details
{ # The matching user resources. "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse". "user": [ # A user of an enterprise. - { # A user resource represents an individual user within the enterprise's domain. - # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. - # - # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. "id": "A String", # The unique ID for the user. }, ], }++patch(enterpriseId, userId, body)+Updates the details of an EMM-managed user. + +Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + } + + +Returns: + An object of the form: + + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + }++revokeToken(enterpriseId, userId)Revokes a previously generated token (activation code) for the user. @@ -220,4 +349,45 @@Method Details
}++update(enterpriseId, userId, body)+Updates the details of an EMM-managed user. + +Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. + +Args: + enterpriseId: string, The ID of the enterprise. (required) + userId: string, The ID of the user. (required) + body: object, The request body. (required) + The object takes the form of: + +{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + } + + +Returns: + An object of the form: + + { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model: + # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). + # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only. + "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". + "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. + "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users. + "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. + "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount. + "id": "A String", # The unique ID for the user. + }+