get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)
Retrieves a user.
- insert(body=None, x__xgafv=None)
insert(body=None, resolveConflictAccount=None, x__xgafv=None)
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.
@@ -227,7 +227,7 @@insert(body=None, x__xgafv=None)
+ insert(body=None, resolveConflictAccount=None, x__xgafv=None)
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. Args: @@ -296,6 +296,7 @@Method Details
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB. } + resolveConflictAccount: boolean, Optional. If set to `true`, the option selected for [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) will apply. Default: `false` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/admob_v1beta.accounts.adSources.adapters.html b/docs/dyn/admob_v1beta.accounts.adSources.adapters.html new file mode 100644 index 00000000000..b534a70132c --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.adSources.adapters.html @@ -0,0 +1,145 @@ + + + +AdMob API . accounts . adSources . adapters
+Instance Methods
++
+close()Close httplib2 connections.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)List the adapters of the ad source.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+List the adapters of the ad source. + +Args: + parent: string, Required. The parent which owns this collection of adapters. Format: accounts/{publisher_id}/adSources/{ad_source_id} (required) + pageSize: integer, The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. + pageToken: string, A page token, received from a previous `ListAdapters` call. Provide this to retrieve the subsequent page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the ListAdaptersRequest. + "adapters": [ # The adapter. + { # Describes adapters supported by each mediation ad source. Adapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the [ad_unit_configurations](#AdUnitMapping.ad_unit_configurations) key/value pairs. For example, the ad_unit_configurations can be used to pass various IDs to the adapter's third-party SDK. + "adapterConfigMetadata": [ # Output only. Configuration metadata associated with this adapter. + { # Configuration metadata associated with this adapter. They are used to define the ad_unit_configurations associated with AdUnitMappings for the this adapter. + "adapterConfigMetadataId": "A String", # This is used to fill the key of the [ad_unit_configurations](#AdUnitMapping.ad_unit_configurations). + "adapterConfigMetadataLabel": "A String", # Name of the adapter configuration metadata. + "isRequired": True or False, # Whether this metadata is required for configuring the AdUnitMappings. + }, + ], + "adapterId": "A String", # Output only. ID of this adapter. It is used to set [adapter_id](#AdUnitMapping.adapter_id). + "formats": [ # Output only. Indicates the formats of the ad units supported by this adapter. + "A String", + ], + "name": "A String", # Output only. Resource name of the adapter. Format is: accounts/{publisher_id}/adSources/{ad_source_id}/adapters/{adapter_id}. + "platform": "A String", # Output only. Mobile application platform supported by this adapter. Supported values are: IOS, ANDROID, WINDOWS_PHONE + "title": "A String", # Output only. The display name of this adapter. + }, + ], + "nextPageToken": "A String", # Used to set the `page_token` in the `ListAdapterRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages. +}+++ + \ No newline at end of file diff --git a/docs/dyn/admob_v1beta.accounts.adSources.html b/docs/dyn/admob_v1beta.accounts.adSources.html index 799934c6e03..fa0b2f5707c 100644 --- a/docs/dyn/admob_v1beta.accounts.adSources.html +++ b/docs/dyn/admob_v1beta.accounts.adSources.html @@ -74,6 +74,11 @@list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++AdMob API . accounts . adSources
Instance Methods
++
+adapters()+Returns the adapters Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/admob_v1beta.accounts.adUnitMappings.html b/docs/dyn/admob_v1beta.accounts.adUnitMappings.html new file mode 100644 index 00000000000..c3a5ff60edf --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.adUnitMappings.html @@ -0,0 +1,138 @@ + + + +AdMob API . accounts . adUnitMappings
+Instance Methods
++
+batchCreate(parent, body=None, x__xgafv=None)Batch create the ad unit mappings under the specific AdMob account. The maximum allowed batch size is 100.
++
+close()Close httplib2 connections.
+Method Details
+++ +batchCreate(parent, body=None, x__xgafv=None)+Batch create the ad unit mappings under the specific AdMob account. The maximum allowed batch size is 100. + +Args: + parent: string, Required. The AdMob account which owns this collection of ad unit mappings. Format: accounts/{publisher_id} See https://support.google.com/admob/answer/2784578 for instructions on how to find your AdMob publisher ID. (required) + body: object, The request body. + The object takes the form of: + +{ # Request to create a batch of ad unit mappings under the specific AdMob account. + "requests": [ # Required. The request message specifying the ad unit mappings to create. A maximum of 100 ad unit mappings can be created in a batch. If the number of ad unit mappings in the batch request exceed 100, the entire request will be rejected and no ad unit mappings will be created. + { # Request to create an ad unit mapping under the specific AdMob account and ad unit. + "adUnitMapping": { # Settings to map an AdMob ad unit to a 3rd party ad unit. # Required. The ad unit mapping to create. + "adUnitConfigurations": { # Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. + "a_key": "A String", + }, + "adapterId": "A String", # The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. + "displayName": "A String", # Optional. The display name of this ad unit mapping instance. + "name": "A String", # Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 + "state": "A String", # Output only. The status of this ad unit mapping. + }, + "parent": "A String", # Required. The parent which owns the ad unit mapping. Format: accounts/{publisher_id}/adUnits/{ad_unit_id} + }, + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response containing a batch of created ad unit mappings. + "adUnitMappings": [ # The Ad units mappings created under the requested account. + { # Settings to map an AdMob ad unit to a 3rd party ad unit. + "adUnitConfigurations": { # Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. + "a_key": "A String", + }, + "adapterId": "A String", # The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. + "displayName": "A String", # Optional. The display name of this ad unit mapping instance. + "name": "A String", # Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 + "state": "A String", # Output only. The status of this ad unit mapping. + }, + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/admob_v1beta.accounts.adUnits.adUnitMappings.html b/docs/dyn/admob_v1beta.accounts.adUnits.adUnitMappings.html new file mode 100644 index 00000000000..fa2ded294a1 --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.adUnits.adUnitMappings.html @@ -0,0 +1,180 @@ + + + +close()+Close httplib2 connections.+AdMob API . accounts . adUnits . adUnitMappings
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Create an ad unit mapping under the specific AdMob account and ad unit.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)List ad unit mappings under the specified AdMob account and ad unit.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Create an ad unit mapping under the specific AdMob account and ad unit. + +Args: + parent: string, Required. The parent which owns the ad unit mapping. Format: accounts/{publisher_id}/adUnits/{ad_unit_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Settings to map an AdMob ad unit to a 3rd party ad unit. + "adUnitConfigurations": { # Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. + "a_key": "A String", + }, + "adapterId": "A String", # The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. + "displayName": "A String", # Optional. The display name of this ad unit mapping instance. + "name": "A String", # Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 + "state": "A String", # Output only. The status of this ad unit mapping. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Settings to map an AdMob ad unit to a 3rd party ad unit. + "adUnitConfigurations": { # Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. + "a_key": "A String", + }, + "adapterId": "A String", # The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. + "displayName": "A String", # Optional. The display name of this ad unit mapping instance. + "name": "A String", # Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 + "state": "A String", # Output only. The status of this ad unit mapping. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+List ad unit mappings under the specified AdMob account and ad unit. + +Args: + parent: string, Required. The parent which owns this collection of ad unit mappings. Format: accounts/{publisher_id}/adUnits/{ad_unit_id} (required) + filter: string, The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "DISPLAY_NAME" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including "DISPLAY_NAME". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Ad Unit Mapping 1", "Test Ad Unit Mapping 2") + pageSize: integer, The maximum number of ad unit mappings to return. If unspecified or 0, at most 10,000 ad unit mappings will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. + pageToken: string, A page token, received from a previous `ListAdUnitMappings` call. Provide this to retrieve the subsequent page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the ListAdUnitMappingsRequest. + "adUnitMappings": [ # The ad unit mappings from the specified account and ad unit. + { # Settings to map an AdMob ad unit to a 3rd party ad unit. + "adUnitConfigurations": { # Settings for the specified ad unit to make an ad request to 3rd party ad network. Key-value pairs with values set by the user for the keys requested by the ad network. Please see https://support.google.com/admob/answer/3245073 for details on how to configure the network settings. + "a_key": "A String", + }, + "adapterId": "A String", # The ID of mediation ad source adapter used by this ad unit mapping. The adapter determines the information needed in the ad_network_settings. + "displayName": "A String", # Optional. The display name of this ad unit mapping instance. + "name": "A String", # Resource name of this ad unit mapping. Format is: accounts/{publisher_id}/adUnits/{ad_unit_id_fragment}/adUnitMappings/{ad_unit_mapping_id} Example: accounts/pub-1234567890123456/adUnits/0123456789/adUnitMappings/987654321 + "state": "A String", # Output only. The status of this ad unit mapping. + }, + ], + "nextPageToken": "A String", # Used to set the `page_token` in the `ListAdUnitMappingsRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages. +}+++ + \ No newline at end of file diff --git a/docs/dyn/admob_v1beta.accounts.adUnits.html b/docs/dyn/admob_v1beta.accounts.adUnits.html index 09ad2fcd3cb..504da51292f 100644 --- a/docs/dyn/admob_v1beta.accounts.adUnits.html +++ b/docs/dyn/admob_v1beta.accounts.adUnits.html @@ -74,9 +74,17 @@list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++AdMob API . accounts . adUnits
Instance Methods
++
+adUnitMappings()+Returns the adUnitMappings Resource.
+Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates an ad unit under the specified AdMob account.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List the ad units under the specified AdMob account.
@@ -89,6 +97,54 @@Method Details
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
+ Creates an ad unit under the specified AdMob account.
+
+Args:
+ parent: string, Required. Resource name of the account to create the specified ad unit for. Example: accounts/pub-9876543210987654 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Describes an AdMob ad unit.
+ "adFormat": "A String", # AdFormat of the ad unit. Possible values are as follows: "APP_OPEN" - App Open ad format. "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and video where video can not be excluded. "REWARDED_INTERSTITIAL" - Rewarded Interstitial ad format. Only supports video ad type. See https://support.google.com/admob/answer/9884467.
+ "adTypes": [ # Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
+ "A String",
+ ],
+ "adUnitId": "A String", # The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789
+ "appId": "A String", # The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789
+ "displayName": "A String", # The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+ "name": "A String", # Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
+ "rewardSettings": { # Settings for a rewarded ad unit. # Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is "REWARDED".
+ "unitAmount": "A String", # Reward amount for this ad unit.
+ "unitType": "A String", # Reward item for this ad unit.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes an AdMob ad unit.
+ "adFormat": "A String", # AdFormat of the ad unit. Possible values are as follows: "APP_OPEN" - App Open ad format. "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and video where video can not be excluded. "REWARDED_INTERSTITIAL" - Rewarded Interstitial ad format. Only supports video ad type. See https://support.google.com/admob/answer/9884467.
+ "adTypes": [ # Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
+ "A String",
+ ],
+ "adUnitId": "A String", # The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789
+ "appId": "A String", # The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789
+ "displayName": "A String", # The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+ "name": "A String", # Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789
+ "rewardSettings": { # Settings for a rewarded ad unit. # Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is "REWARDED".
+ "unitAmount": "A String", # Reward amount for this ad unit.
+ "unitType": "A String", # Reward item for this ad unit.
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List the ad units under the specified AdMob account. @@ -116,6 +172,10 @@Method Details
"appId": "A String", # The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789 "displayName": "A String", # The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters. "name": "A String", # Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789 + "rewardSettings": { # Settings for a rewarded ad unit. # Optional. Settings for a rewarded ad unit. This can be set or unset only when the ad_format is "REWARDED". + "unitAmount": "A String", # Reward amount for this ad unit. + "unitType": "A String", # Reward item for this ad unit. + }, }, ], "nextPageToken": "A String", # If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`. diff --git a/docs/dyn/admob_v1beta.accounts.apps.html b/docs/dyn/admob_v1beta.accounts.apps.html index 8adf3c36c41..54c38d85070 100644 --- a/docs/dyn/admob_v1beta.accounts.apps.html +++ b/docs/dyn/admob_v1beta.accounts.apps.html @@ -77,6 +77,9 @@Instance Methods
Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates an app under the specified AdMob account.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List the apps under the specified AdMob account.
@@ -89,6 +92,58 @@Method Details
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
+ Creates an app under the specified AdMob account.
+
+Args:
+ parent: string, Required. Resource name of the account for which the app is being created. Example: accounts/pub-9876543210987654 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Describes an AdMob app for a specific platform (For example: Android or iOS).
+ "appApprovalState": "A String", # Output only. The approval state for the app. The field is read-only.
+ "appId": "A String", # The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789
+ "linkedAppInfo": { # Information from the app store if the app is linked to an app store. # Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store.
+ "androidAppStores": [ # Optional. The app store information for published Android apps. This field is only used for apps on the Android platform and will be ignored if the PLATFORM is set to iOS. The default value is the Google Play App store. This field can be updated after app is created. If the app is not published, this field will not be included in the response.
+ "A String",
+ ],
+ "appStoreId": "A String", # The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: "com.example.myapp". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example "105169111". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.
+ "displayName": "A String", # Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.
+ },
+ "manualAppInfo": { # Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store). # The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used.
+ "displayName": "A String", # The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+ },
+ "name": "A String", # Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789
+ "platform": "A String", # Describes the platform of the app. Limited to "IOS" and "ANDROID".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes an AdMob app for a specific platform (For example: Android or iOS).
+ "appApprovalState": "A String", # Output only. The approval state for the app. The field is read-only.
+ "appId": "A String", # The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789
+ "linkedAppInfo": { # Information from the app store if the app is linked to an app store. # Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store.
+ "androidAppStores": [ # Optional. The app store information for published Android apps. This field is only used for apps on the Android platform and will be ignored if the PLATFORM is set to iOS. The default value is the Google Play App store. This field can be updated after app is created. If the app is not published, this field will not be included in the response.
+ "A String",
+ ],
+ "appStoreId": "A String", # The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: "com.example.myapp". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example "105169111". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.
+ "displayName": "A String", # Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.
+ },
+ "manualAppInfo": { # Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store). # The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used.
+ "displayName": "A String", # The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.
+ },
+ "name": "A String", # Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789
+ "platform": "A String", # Describes the platform of the app. Limited to "IOS" and "ANDROID".
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List the apps under the specified AdMob account. @@ -111,6 +166,9 @@Method Details
"appApprovalState": "A String", # Output only. The approval state for the app. The field is read-only. "appId": "A String", # The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789 "linkedAppInfo": { # Information from the app store if the app is linked to an app store. # Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store. + "androidAppStores": [ # Optional. The app store information for published Android apps. This field is only used for apps on the Android platform and will be ignored if the PLATFORM is set to iOS. The default value is the Google Play App store. This field can be updated after app is created. If the app is not published, this field will not be included in the response. + "A String", + ], "appStoreId": "A String", # The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: "com.example.myapp". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example "105169111". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked. "displayName": "A String", # Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store. }, diff --git a/docs/dyn/admob_v1beta.accounts.campaigns.html b/docs/dyn/admob_v1beta.accounts.campaigns.html new file mode 100644 index 00000000000..a7a4bd40a0f --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.campaigns.html @@ -0,0 +1,188 @@ + + + +AdMob API . accounts . campaigns
+Instance Methods
++
+batchUpdate(parent, body=None, x__xgafv=None)Batch update operation for campaigns under the specified AdMob publisher.
++
+close()Close httplib2 connections.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)List the campaigns under the specified AdMob account.
+ +Retrieves the next page of results.
+Method Details
+++ +batchUpdate(parent, body=None, x__xgafv=None)+Batch update operation for campaigns under the specified AdMob publisher. + +Args: + parent: string, Required. Resource name of the account to list campaigns for. The `parent` field in the individual UpdateCampaignRequest messages should match the value set here. Example: accounts/pub-9876543210987654 (required) + body: object, The request body. + The object takes the form of: + +{ # The request for the BatchUpdateCampaigns API. + "requests": [ # Required. The individual requests to update campaigns. Max 1000 allowed. + { # An update request for a singular campaign. Currently only cpi_micros of MAX_CPI and TARGET_CPI campaigns can be updated. + "campaign": { # Describes an AdMob campaign. # Required. The campaign which is being updated. + "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign. + "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher. + }, + "displayName": "A String", # Output only. The display name for the campaign. + "goalType": "A String", # Output only. The Goal type of the campaign. + "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789 + }, + "updateMask": "A String", # List of campaign fields to be updated. Currently this field is not supported as only the cpi_micros field can be updated. + }, + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response for the BatchUpdateCampaigns API. + "campaigns": [ # The updated campaigns per the request. + { # Describes an AdMob campaign. + "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign. + "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher. + }, + "displayName": "A String", # Output only. The display name for the campaign. + "goalType": "A String", # Output only. The Goal type of the campaign. + "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789 + }, + ], +}+++ +close()+Close httplib2 connections.+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+List the campaigns under the specified AdMob account. + +Args: + parent: string, Required. Resource name of the account to list campaigns for. Example: accounts/pub-9876543210987654 (required) + filter: string, The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "CAMPAIGN_GOAL_TYPE" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including "CAMPAIGN_GOAL_TYPE". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(CAMPAIGN_GOAL_TYPE, "NUMBER_OF_CLICKS", "MEDIATED_ADS") + pageSize: integer, The maximum number of campaigns to return. + pageToken: string, The value returned by the last `ListCampaignsResponse`; indicates that this is a continuation of a prior `ListGoogleBiddingAdUnits` call, and that the system should return the next page of data. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the ListCampaignsRequest. + "campaigns": [ # The resulting mediation groups for the requested account. + { # Describes an AdMob campaign. + "cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign. + "cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher. + }, + "displayName": "A String", # Output only. The display name for the campaign. + "goalType": "A String", # Output only. The Goal type of the campaign. + "name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789 + }, + ], + "nextPageToken": "A String", # Used to set the `page_token` in the `ListCampaignsRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages. +}+++ + \ No newline at end of file diff --git a/docs/dyn/admob_v1beta.accounts.html b/docs/dyn/admob_v1beta.accounts.html index 26da1963cac..4309d8e5ad4 100644 --- a/docs/dyn/admob_v1beta.accounts.html +++ b/docs/dyn/admob_v1beta.accounts.html @@ -79,6 +79,11 @@list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++Instance Methods
Returns the adSources Resource.
++
+adUnitMappings()+Returns the adUnitMappings Resource.
+ @@ -89,6 +94,16 @@Instance Methods
Returns the apps Resource.
++
+campaigns()+Returns the campaigns Resource.
+ + +Returns the mediationGroups Resource.
+ diff --git a/docs/dyn/admob_v1beta.accounts.mediationGroups.html b/docs/dyn/admob_v1beta.accounts.mediationGroups.html new file mode 100644 index 00000000000..31f700bf039 --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.mediationGroups.html @@ -0,0 +1,357 @@ + + + +AdMob API . accounts . mediationGroups
+Instance Methods
+ +Returns the mediationAbExperiments Resource.
+ ++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Create a mediation group under the specific AdMob account.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)List mediation groups under the specified AdMob account.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Update the specified mediation group under the specified AdMob account.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Create a mediation group under the specific AdMob account. + +Args: + parent: string, Required. The parent which owns the mediation group. Format: accounts/{publisher_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Describes an AdMob mediation group. + "displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters. + "mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group. + "mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property. + "mediationGroupLines": { # The mediation lines used for serving for this mediation group. Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder. + "a_key": { # Settings for an ad network used by a mediation group. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + "name": "A String", # Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 + "state": "A String", # The status of the mediation group. Only enabled mediation groups will be served. + "targeting": { # Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location. # Set of criteria targeted by this mediation group, such as ad units and geo locations. + "adUnitIds": [ # Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790". + "A String", + ], + "excludedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region. + "A String", + ], + "format": "A String", # Ad format targeted by this mediation group. Examples: "banner", "native". + "idfaTargeting": "A String", # The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device. + "platform": "A String", # Describes the platform of the app. Examples: "IOS", "Android". + "targetedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + "A String", + ], + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Describes an AdMob mediation group. + "displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters. + "mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group. + "mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property. + "mediationGroupLines": { # The mediation lines used for serving for this mediation group. Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder. + "a_key": { # Settings for an ad network used by a mediation group. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + "name": "A String", # Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 + "state": "A String", # The status of the mediation group. Only enabled mediation groups will be served. + "targeting": { # Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location. # Set of criteria targeted by this mediation group, such as ad units and geo locations. + "adUnitIds": [ # Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790". + "A String", + ], + "excludedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region. + "A String", + ], + "format": "A String", # Ad format targeted by this mediation group. Examples: "banner", "native". + "idfaTargeting": "A String", # The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device. + "platform": "A String", # Describes the platform of the app. Examples: "IOS", "Android". + "targetedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + "A String", + ], + }, +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+List mediation groups under the specified AdMob account. + +Args: + parent: string, Required. Resource name of the account to list mediation groups for. Example: accounts/pub-9876543210987654 (required) + filter: string, The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible fields to filter by are: - "AD_SOURCE_IDS" - "AD_UNIT_IDS" - "APP_IDS" - "DISPLAY_NAME" - "FORMAT" - "MEDIATION_GROUP_ID" - "PLATFORM" - "STATE" - "TARGETED_REGION_CODES" Possible filter functions are: - `IN`: Used to filter fields that represent a singleton including "MEDIATION_GROUP_ID", "DISPLAY_NAME", "STATE", "PLATFORM", and "FORMAT". - `CONTAINS_ANY`: Used to filter fields that represent a collection including "AD_SOURCE_IDS", "AD_UNIT_IDS", "APP_IDS", and "TARGETED_REGION_CODES". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Group 1", "Test Group 2") AND IN(PLATFORM, "ANDROID") AND CONTAINS_ANY(AD_SOURCE_IDS, "5450213213286189855") + pageSize: integer, The maximum number of mediation groups to return. If unspecified or 0, at most 10,000 mediation groups will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000. + pageToken: string, The value returned by the last `ListMediationGroupsResponse`; indicates that this is a continuation of a prior `ListMediationGroups` call, and that the system should return the next page of data. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the mediation groups list request. + "mediationGroups": [ # The resulting mediation groups for the requested account. + { # Describes an AdMob mediation group. + "displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters. + "mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group. + "mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property. + "mediationGroupLines": { # The mediation lines used for serving for this mediation group. Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder. + "a_key": { # Settings for an ad network used by a mediation group. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + "name": "A String", # Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 + "state": "A String", # The status of the mediation group. Only enabled mediation groups will be served. + "targeting": { # Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location. # Set of criteria targeted by this mediation group, such as ad units and geo locations. + "adUnitIds": [ # Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790". + "A String", + ], + "excludedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region. + "A String", + ], + "format": "A String", # Ad format targeted by this mediation group. Examples: "banner", "native". + "idfaTargeting": "A String", # The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device. + "platform": "A String", # Describes the platform of the app. Examples: "IOS", "Android". + "targetedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + "A String", + ], + }, + }, + ], + "nextPageToken": "A String", # If not empty, indicates that there may be more mediation groups for the request; this value should be passed in a new `ListMediationGroupsRequest`. +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/admob_v1beta.accounts.mediationGroups.mediationAbExperiments.html b/docs/dyn/admob_v1beta.accounts.mediationGroups.mediationAbExperiments.html new file mode 100644 index 00000000000..bbdc5a8a2cd --- /dev/null +++ b/docs/dyn/admob_v1beta.accounts.mediationGroups.mediationAbExperiments.html @@ -0,0 +1,252 @@ + + + +patch(name, body=None, updateMask=None, x__xgafv=None)+Update the specified mediation group under the specified AdMob account. + +Args: + name: string, Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 (required) + body: object, The request body. + The object takes the form of: + +{ # Describes an AdMob mediation group. + "displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters. + "mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group. + "mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property. + "mediationGroupLines": { # The mediation lines used for serving for this mediation group. Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder. + "a_key": { # Settings for an ad network used by a mediation group. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + "name": "A String", # Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 + "state": "A String", # The status of the mediation group. Only enabled mediation groups will be served. + "targeting": { # Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location. # Set of criteria targeted by this mediation group, such as ad units and geo locations. + "adUnitIds": [ # Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790". + "A String", + ], + "excludedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region. + "A String", + ], + "format": "A String", # Ad format targeted by this mediation group. Examples: "banner", "native". + "idfaTargeting": "A String", # The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device. + "platform": "A String", # Describes the platform of the app. Examples: "IOS", "Android". + "targetedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + "A String", + ], + }, +} + + updateMask: string, List of mediation group fields to be updated. Updates to repeated fields such as items in a list will fully replace the existing value(s) with the new value(s). Updates to individual values in a map can be done by indexing by the key. The following field masks are supported for mediation group updates: - "mediation_group_lines[\"{mediation_group_line_id}\"]" clang-format off - "mediation_group_lines[\"{mediation_group_line_id}\"].ad_unit_mappings[\"{ad_unit_id}\"]" clang-format on - "mediation_group_lines[\"{mediation_group_line_id}\"].cpm_micros" - "mediation_group_lines[\"{mediation_group_line_id}\"].cpm_mode" - "mediation_group_lines[\"{mediation_group_line_id}\"].state" - "mediation_group_lines[\"{mediation_group_line_id}\"].display_name" - "targeting.ad_unit_ids" To update a mediation group with a new mediation group line, use a distinct negative number for the "mediation_group_line_id". For Example: update_mask { paths: "mediation_group_lines[\"123456789012345\"].cpm_micros" } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Describes an AdMob mediation group. + "displayName": "A String", # User provided name for the mediation group. The maximum length allowed is 120 characters. + "mediationAbExperimentState": "A String", # Output only. The state of the mediation a/b experiment that belongs to this mediation group. + "mediationGroupId": "A String", # The ID of the mediation group. Example: "0123456789". This is a read only property. + "mediationGroupLines": { # The mediation lines used for serving for this mediation group. Key is the ID of the mediation group line. For creation, use distinct negative values as placeholder. + "a_key": { # Settings for an ad network used by a mediation group. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + "name": "A String", # Resource name for this mediation group. Format is: accounts/{publisher_id}/mediationGroups/{mediation_group_id} Example: accounts/pub-9876543210987654/mediationGroups/0123456789 + "state": "A String", # The status of the mediation group. Only enabled mediation groups will be served. + "targeting": { # Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location. # Set of criteria targeted by this mediation group, such as ad units and geo locations. + "adUnitIds": [ # Ad units targeted by this mediation group. Example: "ca-app-pub-1234/8790". + "A String", + ], + "excludedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group does not exclude any region. + "A String", + ], + "format": "A String", # Ad format targeted by this mediation group. Examples: "banner", "native". + "idfaTargeting": "A String", # The parameter can be used to target ad requests based on the availability of the IDFA. If set to ALL, the mediation group applies to all ad requests (with or without IDFA). If set to AVAILABLE, the mediation group applies to ad requests with IDFA. If set to NOT_AVAILABLE, the mediation group applies to ad requests without IDFA. Doesn't need to be specified for an ANDROID device. + "platform": "A String", # Describes the platform of the app. Examples: "IOS", "Android". + "targetedRegionCodes": [ # The Unicode country/region code (CLDR) of a location, such as "US". Unset if this mediation group targets all available regions. For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag. + "A String", + ], + }, +}+AdMob API . accounts . mediationGroups . mediationAbExperiments
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Create an A/B testing experiment for a specified AdMob account and a mediation group.
++
+stop(name, body=None, x__xgafv=None)Stop the mediation A/B experiment and choose a variant.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Create an A/B testing experiment for a specified AdMob account and a mediation group. + +Args: + parent: string, Required. The parent which owns the mediation group. Format: accounts/{publisher_id}/mediationGroups/{mediation_group_id} (required) + body: object, The request body. + The object takes the form of: + +{ # The mediation A/B experiment. NEXT ID: 12 + "controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "displayName": "A String", # The display name for the mediation A/B experiment. + "experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property. + "name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345 + "state": "A String", # Output only. The state of the experiment. It is an output only field. + "treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The mediation A/B experiment. NEXT ID: 12 + "controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "displayName": "A String", # The display name for the mediation A/B experiment. + "experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property. + "name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345 + "state": "A String", # Output only. The state of the experiment. It is an output only field. + "treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details. +}+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 01b189b831b..623afe6c97c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -168,6 +168,7 @@stop(name, body=None, x__xgafv=None)+Stop the mediation A/B experiment and choose a variant. + +Args: + name: string, Name of the mediation group, the experiment for which to choose a variant for. Example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiments (required) + body: object, The request body. + The object takes the form of: + +{ # Request to end the mediation A/B experiment and choose a winning variant. + "variantChoice": "A String", # The choice for the winning variant. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The mediation A/B experiment. NEXT ID: 12 + "controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "displayName": "A String", # The display name for the mediation A/B experiment. + "experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property. + "name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345 + "state": "A String", # Output only. The state of the experiment. It is an output only field. + "treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING. + { # The mediation group line for the experiment. It will be used for serving during the run of the experiment. + "mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment. + "adSourceId": "A String", # The ID of the ad source this mediation line is associated with. + "adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored. + "a_key": "A String", + }, + "cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros. + "cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes. + "displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters. + "experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to. + "id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder. + "state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served. + }, + }, + ], + "treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details. +}+Method Details
"A String", ], "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. + "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. "timeout": "A String", # The maximum job running time. The default is 7 days. }, @@ -275,6 +276,7 @@Method Details
"A String", ], "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. + "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. "timeout": "A String", # The maximum job running time. The default is 7 days. }, @@ -424,6 +426,7 @@Method Details
"A String", ], "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. + "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. "timeout": "A String", # The maximum job running time. The default is 7 days. }, @@ -544,6 +547,7 @@Method Details
"A String", ], "scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. + "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. "timeout": "A String", # The maximum job running time. The default is 7 days. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.html index e758e66d8e5..6aff1825da5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.features.html @@ -141,9 +141,6 @@Method Details
"name": "A String", # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. "valueType": "A String", # Required. Immutable. Type of Feature value. - "versionLabels": { # The labels with user-defined metadata to organize your versions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - "a_key": "A String", - }, }, "featureId": "A String", # Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. "parent": "A String", # Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` @@ -219,9 +216,6 @@Method Details
"name": "A String", # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. "valueType": "A String", # Required. Immutable. Type of Feature value. - "versionLabels": { # The labels with user-defined metadata to organize your versions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - "a_key": "A String", - }, } featureId: string, Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. @@ -328,9 +322,6 @@Method Details
"name": "A String", # Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. "valueType": "A String", # Required. Immutable. Type of Feature value. - "versionLabels": { # The labels with user-defined metadata to organize your versions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - "a_key": "A String", - }, }
Returns the measurementProtocolSecrets Resource.
+
+ sKAdNetworkConversionValueSchema()
+
Returns the sKAdNetworkConversionValueSchema Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html new file mode 100644 index 00000000000..b9f3dfdb57c --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html @@ -0,0 +1,600 @@ + + + +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a SKAdNetworkConversionValueSchema.
+ +Deletes target SKAdNetworkConversionValueSchema.
+ +Looks up a single SKAdNetworkConversionValueSchema.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a SKAdNetworkConversionValueSchema.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a SKAdNetworkConversionValueSchema.
+
+Args:
+ parent: string, Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes target SKAdNetworkConversionValueSchema.
+
+Args:
+ name: string, Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Looks up a single SKAdNetworkConversionValueSchema.
+
+Args:
+ name: string, Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.
+
+Args:
+ parent: string, Required. Format: properties/{property_id}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema Example: properties/1234/dataStreams/5678/sKAdNetworkConversionValueSchema (required)
+ pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+ pageToken: string, A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListSKAdNetworkConversionValueSchemas RPC
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one SKAdNetworkConversionValueSchema per dataStream, so this will never be populated.
+ "skadnetworkConversionValueSchemas": [ # List of SKAdNetworkConversionValueSchemas. This will have at most one value.
+ { # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ },
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a SKAdNetworkConversionValueSchema.
+
+Args:
+ name: string, Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+}
+
+ updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # SKAdNetwork conversion value schema of an iOS stream.
+ "applyConversionValues": True or False, # If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
+ "name": "A String", # Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
+ "postbackWindowOne": { # Settings for a SKAdNetwork conversion postback window. # Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowThree": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+ "postbackWindowTwo": { # Settings for a SKAdNetwork conversion postback window. # The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
+ "conversionValues": [ # Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
+ { # Conversion value settings for a postback window for SKAdNetwork conversion value schema.
+ "coarseValue": "A String", # Required. A coarse grained conversion value. This value is not guaranteed to be unique.
+ "displayName": "A String", # Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
+ "eventMappings": [ # Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
+ { # Event setting conditions to match an event.
+ "eventName": "A String", # Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
+ "maxEventCount": "A String", # The maximum number of times the event occurred. If not set, maximum event count won't be checked.
+ "maxEventValue": 3.14, # The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked.
+ "minEventCount": "A String", # At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked.
+ "minEventValue": 3.14, # The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked.
+ },
+ ],
+ "fineValue": 42, # The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
+ "lockEnabled": True or False, # If true, the SDK should lock to this conversion value for the current postback window.
+ },
+ ],
+ "postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
+ },
+}
+Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`. The attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details` can be used to store developers and their roles. The JSON format expected is: [ { "developer_id":"", "roles":[ "" ] } ] and is dealt in base64encoded format. Etag will be available in attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details_etag` for that AppGroup.
+Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`.
Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.
@@ -99,7 +99,7 @@Retrieves the next page of results.
update(name, action=None, body=None, x__xgafv=None)
Updates an appGroup. This API replaces the existing appGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. The custom attribute limit is 1000, and is how `__apigee_reserved__developer_details` can be updated. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
+Updates an appGroup. This API replaces the existing appGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
close()
@@ -108,7 +108,7 @@ create(parent, body=None, x__xgafv=None)
- Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`. The attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details` can be used to store developers and their roles. The JSON format expected is: [ { "developer_id":"", "roles":[ "" ] } ] and is dealt in base64encoded format. Etag will be available in attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details_etag` for that AppGroup.
+ Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`.
Args:
parent: string, Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request: `organizations/{org}`. (required)
@@ -232,7 +232,7 @@ Method Details
Args:
parent: string, Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`. (required)
- filter: string, The filter expression to be used to get the list of AppGroups, where filtering can be done on name, correlationID or channelID of the app group. Example: filter = "name = foobar"
+ filter: string, The filter expression to be used to get the list of AppGroups, where filtering can be done on status, channelId or channelUri of the app group. Examples: filter=status=active", filter=channelId=, filter=channelUri=
pageSize: integer, Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, The starting index record for listing the AppGroups.
x__xgafv: string, V1 error format.
@@ -284,7 +284,7 @@ Method Details
update(name, action=None, body=None, x__xgafv=None)
- Updates an appGroup. This API replaces the existing appGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. The custom attribute limit is 1000, and is how `__apigee_reserved__developer_details` can be updated. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
+ Updates an appGroup. This API replaces the existing appGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
Args:
name: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
diff --git a/docs/dyn/apigee_v1.organizations.apps.html b/docs/dyn/apigee_v1.organizations.apps.html
index bfe43349d32..6b127f71c4c 100644
--- a/docs/dyn/apigee_v1.organizations.apps.html
+++ b/docs/dyn/apigee_v1.organizations.apps.html
@@ -169,7 +169,7 @@ Method Details
apiProduct: string, API product.
apptype: string, Optional. 'apptype' is no longer available. Use a 'filter' instead.
expand: boolean, Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
- filter: string, Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName and appType. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
+ filter: string, Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
ids: string, Optional. Comma-separated list of app IDs on which to filter.
includeCred: boolean, Optional. Flag that specifies whether to include credentials in the response.
keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
diff --git a/docs/dyn/apigee_v1.organizations.deployments.html b/docs/dyn/apigee_v1.organizations.deployments.html
index edbb9cd441b..3d138029c60 100644
--- a/docs/dyn/apigee_v1.organizations.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.deployments.html
@@ -150,6 +150,7 @@ Method Details
"statusCodeDetails": "A String", # Human-readable message associated with the status code.
},
],
+ "proxyDeploymentType": "A String", # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
"revision": "A String", # API proxy revision.
"routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status.
{ # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
diff --git a/docs/dyn/apigee_v1.organizations.endpointAttachments.html b/docs/dyn/apigee_v1.organizations.endpointAttachments.html
index c52eb024180..48e631af44c 100644
--- a/docs/dyn/apigee_v1.organizations.endpointAttachments.html
+++ b/docs/dyn/apigee_v1.organizations.endpointAttachments.html
@@ -140,7 +140,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -175,7 +175,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
diff --git a/docs/dyn/apigee_v1.organizations.envgroups.attachments.html b/docs/dyn/apigee_v1.organizations.envgroups.attachments.html
index c7e28120459..0974cb6a1e5 100644
--- a/docs/dyn/apigee_v1.organizations.envgroups.attachments.html
+++ b/docs/dyn/apigee_v1.organizations.envgroups.attachments.html
@@ -137,7 +137,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -172,7 +172,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
diff --git a/docs/dyn/apigee_v1.organizations.envgroups.html b/docs/dyn/apigee_v1.organizations.envgroups.html
index fff371980a3..b82ba7daef4 100644
--- a/docs/dyn/apigee_v1.organizations.envgroups.html
+++ b/docs/dyn/apigee_v1.organizations.envgroups.html
@@ -152,7 +152,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -187,7 +187,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -358,7 +358,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html b/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
index aa0db594443..046eb460c38 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
@@ -149,6 +149,7 @@ Method Details
"statusCodeDetails": "A String", # Human-readable message associated with the status code.
},
],
+ "proxyDeploymentType": "A String", # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
"revision": "A String", # API proxy revision.
"routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status.
{ # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
index 80b63cc8bb1..28ac9362b6f 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
@@ -166,6 +166,7 @@ Method Details
"statusCodeDetails": "A String", # Human-readable message associated with the status code.
},
],
+ "proxyDeploymentType": "A String", # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
"revision": "A String", # API proxy revision.
"routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status.
{ # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
@@ -245,6 +246,7 @@ Method Details
"statusCodeDetails": "A String", # Human-readable message associated with the status code.
},
],
+ "proxyDeploymentType": "A String", # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
"revision": "A String", # API proxy revision.
"routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status.
{ # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
diff --git a/docs/dyn/apigee_v1.organizations.environments.archiveDeployments.html b/docs/dyn/apigee_v1.organizations.environments.archiveDeployments.html
index 6d8a9df4a1c..bbf842fb12b 100644
--- a/docs/dyn/apigee_v1.organizations.environments.archiveDeployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.archiveDeployments.html
@@ -150,7 +150,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
diff --git a/docs/dyn/apigee_v1.organizations.environments.deployments.html b/docs/dyn/apigee_v1.organizations.environments.deployments.html
index 68f5de5d587..0b20c6a8818 100644
--- a/docs/dyn/apigee_v1.organizations.environments.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.deployments.html
@@ -150,6 +150,7 @@ Method Details
"statusCodeDetails": "A String", # Human-readable message associated with the status code.
},
],
+ "proxyDeploymentType": "A String", # Output only. The type of the deployment (standard or extensible) Deployed proxy revision will be marked as extensible in following 2 cases. 1. The deployed proxy revision uses extensible policies. 2. If a environment supports flowhooks and flow hook is configured.
"revision": "A String", # API proxy revision.
"routeConflicts": [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status.
{ # Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html
index 8b9c3fc9b2c..e468d021644 100644
--- a/docs/dyn/apigee_v1.organizations.environments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.html
@@ -262,6 +262,7 @@ Method Details
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
+ "type": "A String", # Optional. EnvironmentType selected for the environment.
}
name: string, Optional. Name of the environment.
@@ -288,7 +289,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -323,7 +324,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -367,6 +368,7 @@ Method Details
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
+ "type": "A String", # Optional. EnvironmentType selected for the environment.
}
@@ -630,7 +632,7 @@ Method Details
Returns:
An object of the form:
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
@@ -720,6 +722,7 @@ Method Details
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
+ "type": "A String", # Optional. EnvironmentType selected for the environment.
}
updateMask: string, List of fields to be updated. Fields that can be updated: node_config.
@@ -746,7 +749,7 @@ Method Details
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
@@ -762,7 +765,7 @@ Method Details
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
@@ -804,7 +807,7 @@ Method Details
Returns:
An object of the form:
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
@@ -944,6 +947,7 @@ Method Details
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
+ "type": "A String", # Optional. EnvironmentType selected for the environment.
}
x__xgafv: string, V1 error format.
@@ -978,6 +982,7 @@ Method Details
],
},
"state": "A String", # Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use.
+ "type": "A String", # Optional. EnvironmentType selected for the environment.
}
Close httplib2 connections.
+
+ create(parent, body=None, securityProfileId=None, x__xgafv=None)
CreateSecurityProfile create a new custom security profile.
+ +DeleteSecurityProfile delete a profile with all its revisions.
GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
@@ -97,12 +103,138 @@Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
UpdateSecurityProfile update the metadata of security profile.
close()
Close httplib2 connections.
create(parent, body=None, securityProfileId=None, x__xgafv=None)
+ CreateSecurityProfile create a new custom security profile.
+
+Args:
+ parent: string, Required. Name of organization. Format: organizations/{org} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SecurityProfile resource.
+ "description": "A String", # Description of the security profile.
+ "displayName": "A String", # Display name of the security profile.
+ "environments": [ # List of environments attached to security profile.
+ { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
+ "attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
+ "environment": "A String", # Output only. Name of the environment.
+ },
+ ],
+ "maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
+ "minScore": 42, # Output only. Minimum security score that can be generated by this profile.
+ "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
+ "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
+ "categories": [ # List of categories of profile config.
+ { # Advanced API Security provides security profile that scores the following categories.
+ "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
+ },
+ "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
+ },
+ "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
+ },
+ "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
+ },
+ "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
+ },
+ "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
+ },
+ },
+ ],
+ },
+ "revisionCreateTime": "A String", # Output only. The time when revision was created.
+ "revisionId": "A String", # Output only. Revision ID of the security profile.
+ "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
+ "revisionUpdateTime": "A String", # Output only. The time when revision was updated.
+ "scoringConfigs": [ # List of profile scoring configs in this revision.
+ { # Security configurations to manage scoring.
+ "description": "A String", # Description of the config.
+ "scorePath": "A String", # Path of the component config used for scoring.
+ "title": "A String", # Title of the config.
+ },
+ ],
+}
+
+ securityProfileId: string, Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 4-63 characters, and valid characters are /(^[a-z]([a-z0-9-]{​0,61}[a-z0-9])?$/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a SecurityProfile resource.
+ "description": "A String", # Description of the security profile.
+ "displayName": "A String", # Display name of the security profile.
+ "environments": [ # List of environments attached to security profile.
+ { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
+ "attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
+ "environment": "A String", # Output only. Name of the environment.
+ },
+ ],
+ "maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
+ "minScore": 42, # Output only. Minimum security score that can be generated by this profile.
+ "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
+ "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
+ "categories": [ # List of categories of profile config.
+ { # Advanced API Security provides security profile that scores the following categories.
+ "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
+ },
+ "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
+ },
+ "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
+ },
+ "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
+ },
+ "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
+ },
+ "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
+ },
+ },
+ ],
+ },
+ "revisionCreateTime": "A String", # Output only. The time when revision was created.
+ "revisionId": "A String", # Output only. Revision ID of the security profile.
+ "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
+ "revisionUpdateTime": "A String", # Output only. The time when revision was updated.
+ "scoringConfigs": [ # List of profile scoring configs in this revision.
+ { # Security configurations to manage scoring.
+ "description": "A String", # Description of the config.
+ "scorePath": "A String", # Path of the component config used for scoring.
+ "title": "A String", # Title of the config.
+ },
+ ],
+}
+delete(name, x__xgafv=None)
+ DeleteSecurityProfile delete a profile with all its revisions.
+
+Args:
+ name: string, Required. Name of profile. Format: organizations/{org}/securityProfiles/{profile} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization. @@ -129,6 +261,24 @@Method Details
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile. "minScore": 42, # Output only. Minimum security score that can be generated by this profile. "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} + "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score. + "categories": [ # List of categories of profile config. + { # Advanced API Security provides security profile that scores the following categories. + "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. + }, + "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place. + }, + "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place. + }, + "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place. + }, + "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server. + }, + "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place. + }, + }, + ], + }, "revisionCreateTime": "A String", # Output only. The time when revision was created. "revisionId": "A String", # Output only. Revision ID of the security profile. "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. @@ -174,6 +324,24 @@Method Details
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile. "minScore": 42, # Output only. Minimum security score that can be generated by this profile. "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} + "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score. + "categories": [ # List of categories of profile config. + { # Advanced API Security provides security profile that scores the following categories. + "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. + }, + "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place. + }, + "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place. + }, + "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place. + }, + "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server. + }, + "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place. + }, + }, + ], + }, "revisionCreateTime": "A String", # Output only. The time when revision was created. "revisionId": "A String", # Output only. Revision ID of the security profile. "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. @@ -221,6 +389,24 @@Method Details
"maxScore": 42, # Output only. Maximum security score that can be generated by this profile. "minScore": 42, # Output only. Minimum security score that can be generated by this profile. "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} + "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score. + "categories": [ # List of categories of profile config. + { # Advanced API Security provides security profile that scores the following categories. + "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. + }, + "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place. + }, + "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place. + }, + "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place. + }, + "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server. + }, + "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place. + }, + }, + ], + }, "revisionCreateTime": "A String", # Output only. The time when revision was created. "revisionId": "A String", # Output only. Revision ID of the security profile. "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. @@ -265,4 +451,109 @@Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
+ UpdateSecurityProfile update the metadata of security profile.
+
+Args:
+ name: string, Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SecurityProfile resource.
+ "description": "A String", # Description of the security profile.
+ "displayName": "A String", # Display name of the security profile.
+ "environments": [ # List of environments attached to security profile.
+ { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
+ "attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
+ "environment": "A String", # Output only. Name of the environment.
+ },
+ ],
+ "maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
+ "minScore": 42, # Output only. Minimum security score that can be generated by this profile.
+ "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
+ "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
+ "categories": [ # List of categories of profile config.
+ { # Advanced API Security provides security profile that scores the following categories.
+ "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
+ },
+ "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
+ },
+ "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
+ },
+ "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
+ },
+ "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
+ },
+ "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
+ },
+ },
+ ],
+ },
+ "revisionCreateTime": "A String", # Output only. The time when revision was created.
+ "revisionId": "A String", # Output only. Revision ID of the security profile.
+ "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
+ "revisionUpdateTime": "A String", # Output only. The time when revision was updated.
+ "scoringConfigs": [ # List of profile scoring configs in this revision.
+ { # Security configurations to manage scoring.
+ "description": "A String", # Description of the config.
+ "scorePath": "A String", # Path of the component config used for scoring.
+ "title": "A String", # Title of the config.
+ },
+ ],
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a SecurityProfile resource.
+ "description": "A String", # Description of the security profile.
+ "displayName": "A String", # Display name of the security profile.
+ "environments": [ # List of environments attached to security profile.
+ { # Environment information of attached environments. Scoring an environment is enabled only if it is attached to a security profile.
+ "attachTime": "A String", # Output only. Time at which environment was attached to the security profile.
+ "environment": "A String", # Output only. Name of the environment.
+ },
+ ],
+ "maxScore": 42, # Output only. Maximum security score that can be generated by this profile.
+ "minScore": 42, # Output only. Minimum security score that can be generated by this profile.
+ "name": "A String", # Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
+ "profileConfig": { # ProfileConfig defines a set of categories and policies which will be used to compute security score. # Required. Customized profile configuration that computes the security score.
+ "categories": [ # List of categories of profile config.
+ { # Advanced API Security provides security profile that scores the following categories.
+ "abuse": { # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization. # Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
+ },
+ "authorization": { # By default, following policies will be included: - JWS - JWT - OAuth - BasicAuth - APIKey # Checks to see if you have an authorization policy in place.
+ },
+ "cors": { # Checks to see if you have CORS policy in place. # Checks to see if you have CORS policy in place.
+ },
+ "mediation": { # By default, following policies will be included: - OASValidation - SOAPMessageValidation # Checks to see if you have a mediation policy in place.
+ },
+ "mtls": { # Checks to see if you have configured mTLS for the target server. # Checks to see if you have configured mTLS for the target server.
+ },
+ "threat": { # By default, following policies will be included: - XMLThreatProtection - JSONThreatProtection # Checks to see if you have a threat protection policy in place.
+ },
+ },
+ ],
+ },
+ "revisionCreateTime": "A String", # Output only. The time when revision was created.
+ "revisionId": "A String", # Output only. Revision ID of the security profile.
+ "revisionPublishTime": "A String", # Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
+ "revisionUpdateTime": "A String", # Output only. The time when revision was updated.
+ "scoringConfigs": [ # List of profile scoring configs in this revision.
+ { # Security configurations to manage scoring.
+ "description": "A String", # Description of the config.
+ "scorePath": "A String", # Path of the component config used for scoring.
+ "title": "A String", # Title of the config.
+ },
+ ],
+}
+